> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.mixlayer.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mixlayer.com/_mcp/server.

# Start a CLI device login

POST https://api.mixlayer.com/v1/cli/device_authorizations
Content-Type: application/json

Unauthenticated. Returns a device code for the CLI to poll and a user code to approve in the console.

Reference: https://docs.mixlayer.com/api-reference/platform-api/cli/start-device-authorization

## Request

### Body (application/json)

This endpoint expects a StartDeviceAuthorizationRequest.

- `client_name` (string, optional, nullable) — Label for the key that will be created, e.g. `mxl 0.4.0 on laptop`.

## Response

### 200

Device login started

- `data` (ApiDataResponseDeviceAuthorizationResponseData, required) — A started device login.

## Errors

### 400 Bad Request Error

The request body contains malformed JSON or invalid values.

- `error` (ApiErrorBody, required) — Structured error details.

### 401 Unauthorized Error

Authentication is missing or invalid.

- `error` (ApiErrorBody, required) — Structured error details.

### 403 Forbidden Error

The authenticated principal cannot perform this operation.

- `error` (ApiErrorBody, required) — Structured error details.

### 413 Content Too Large Error

The request body exceeds the configured size limit.

- `error` (ApiErrorBody, required) — Structured error details.

### 415 Unsupported Media Type Error

The request does not have a JSON content type.

- `error` (ApiErrorBody, required) — Structured error details.

### 422 Unprocessable Entity Error

The JSON body does not match the request schema or contains a rejected field value.

- `error` (ApiErrorBody, required) — Structured error details.

### 500 Internal Server Error

An unexpected server or database error occurred.

- `error` (ApiErrorBody, required) — Structured error details.

### 503 Service Unavailable Error

Authentication or the required IP policy could not be refreshed.

- `error` (ApiErrorBody, required) — Structured error details.

## Types

### ApiDataResponseDeviceAuthorizationResponseData

A started device login.

- `device_code` (string, required) — Secret the CLI polls with. Never shown to the user.
- `expires_in` (long, required) — Seconds until the grant expires.
- `interval` (long, required) — Minimum seconds between polls.
- `user_code` (string, required) — Code the user confirms in the console.
- `verification_uri` (string, required) — Console page where the user approves the login.
- `verification_uri_complete` (string, required) — `verification_uri` with the user code pre-filled.

### ApiErrorBody

Structured error details returned by the platform API.

- `message` (string, required) — Human-readable error message.
- `code` (string, optional, nullable) — Stable machine-readable error code, when available.
- `details` (any, optional) — Error-specific structured context, when available.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "data": {
    "device_code": "string",
    "expires_in": 1,
    "interval": 1,
    "user_code": "string",
    "verification_uri": "string",
    "verification_uri_complete": "string"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.mixlayer.com/v1/cli/device_authorizations"

payload = {}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.mixlayer.com/v1/cli/device_authorizations';
const options = {method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{}'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixlayer.com/v1/cli/device_authorizations"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.mixlayer.com/v1/cli/device_authorizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.mixlayer.com/v1/cli/device_authorizations")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.mixlayer.com/v1/cli/device_authorizations', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```