Authentication API Reference

This section covers all endpoints related to authentication.

Registry Auth

Authentication registry/docker pull requests.

Endpoint: GET /registry/auth

Parameters

Parameter	Type	Required	Description
X-Chutes-Hotkey	string | null	No
X-Chutes-Signature	string | null	No
X-Chutes-Nonce	string | null	No
Authorization	string | null	No

Responses

Status Code	Description
200	Successful Response
422	Validation Error

Authentication

This endpoint requires authentication.

---

List Keys

List (and optionally filter/paginate) keys.

Endpoint: GET /api_keys/

Parameters

Parameter	Type	Required	Description
page	integer | null	No
limit	integer | null	No
X-Chutes-Hotkey	string | null	No
X-Chutes-Signature	string | null	No
X-Chutes-Nonce	string | null	No
Authorization	string | null	No

Responses

Status Code	Description
200	Successful Response
422	Validation Error

Authentication

This endpoint requires authentication.

---

Create Api Key

Create a new API key.

Endpoint: POST /api_keys/

Parameters

Parameter	Type	Required	Description
X-Chutes-Hotkey	string | null	No
X-Chutes-Signature	string | null	No
X-Chutes-Nonce	string | null	No
Authorization	string | null	No

Request Body

Field	Type	Required	Description
admin	boolean	Yes
name	string	Yes
scopes	ScopeArgs[] | null	No

Responses

Status Code	Description
200	Successful Response
422	Validation Error

Authentication

This endpoint requires authentication.

---

Get Key

Get a single key.

Endpoint: GET /api_keys/{api_key_id}

Parameters

Parameter	Type	Required	Description
api_key_id	string	Yes
X-Chutes-Hotkey	string | null	No
X-Chutes-Signature	string | null	No
X-Chutes-Nonce	string | null	No
Authorization	string | null	No

Responses

Status Code	Description
200	Successful Response
422	Validation Error

Authentication

This endpoint requires authentication.

---

Delete Api Key

Delete an API key by ID.

Endpoint: DELETE /api_keys/{api_key_id}

Parameters

Parameter	Type	Required	Description
api_key_id	string	Yes
X-Chutes-Hotkey	string | null	No
X-Chutes-Signature	string | null	No
X-Chutes-Nonce	string | null	No
Authorization	string | null	No

Responses

Status Code	Description
200	Successful Response
422	Validation Error

Authentication

This endpoint requires authentication.

---