> For the complete documentation index, see [llms.txt](https://docs.podplay.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.podplay.app/api/configuration/api-keys.md).
# Api Keys
API key management and access control.
## GET /api-keys/{apiKeyId}
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Api Keys","description":"API key management and access control."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ApiKeyDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string","description":"Display name for the API key"},"apiKeySecret":{"type":"string","readOnly":true},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"user":{"$ref":"#/components/schemas/ItemRefDto"},"isReadonly":{"type":"boolean","description":"When enabled, this API key is restricted to safe, read-only HTTP methods (GET, HEAD, OPTIONS, TRACE) and cannot perform writes","default":false},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","status","user","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/api-keys/{apiKeyId}":{"get":{"operationId":"ApiKeysController_findOne","parameters":[{"name":"apiKeyId","required":true,"in":"path","schema":{"type":"string"}},{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returns an `ApiKey`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyDto"}}}}},"tags":["Api Keys"]}}}}
```
## PATCH /api-keys/{apiKeyId}
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Api Keys","description":"API key management and access control."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ApiKeyPatchableDto":{"type":"object","properties":{"displayName":{"type":"string","description":"Display name for the API key"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"isReadonly":{"type":"boolean","description":"When enabled, this API key is restricted to safe, read-only HTTP methods (GET, HEAD, OPTIONS, TRACE) and cannot perform writes","default":false}}},"ApiKeyDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string","description":"Display name for the API key"},"apiKeySecret":{"type":"string","readOnly":true},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"user":{"$ref":"#/components/schemas/ItemRefDto"},"isReadonly":{"type":"boolean","description":"When enabled, this API key is restricted to safe, read-only HTTP methods (GET, HEAD, OPTIONS, TRACE) and cannot perform writes","default":false},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","status","user","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/api-keys/{apiKeyId}":{"patch":{"operationId":"ApiKeysController_updateApiKey","parameters":[{"name":"apiKeyId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"The `ApiKey` to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyPatchableDto"}}}},"responses":{"200":{"description":"Returns an `ApiKey`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyDto"}}}},"403":{"description":"Returns an `ApiKey`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyDto"}}}}},"tags":["Api Keys"]}}}}
```
## GET /api-keys
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Api Keys","description":"API key management and access control."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ApiKeyCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"ApiKeyDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string","description":"Display name for the API key"},"apiKeySecret":{"type":"string","readOnly":true},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"user":{"$ref":"#/components/schemas/ItemRefDto"},"isReadonly":{"type":"boolean","description":"When enabled, this API key is restricted to safe, read-only HTTP methods (GET, HEAD, OPTIONS, TRACE) and cannot perform writes","default":false},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","status","user","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/api-keys":{"get":{"operationId":"ApiKeysController_findAll","parameters":[{"name":"displayName","required":false,"in":"query","description":"Filter by api key display name","schema":{"type":"string"}},{"name":"isReadonly","required":false,"in":"query","description":"Filter by read-only status (true / false)","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"ipp","required":false,"in":"query","schema":{"type":"number"}},{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"status","required":false,"in":"query","description":"Filter by status","schema":{}}],"responses":{"200":{"description":"Returns an `ApiKeyCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCollectionDto"}}}}},"tags":["Api Keys"]}}}}
```
## POST /api-keys
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Api Keys","description":"API key management and access control."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ApiKeyDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string","description":"Display name for the API key"},"apiKeySecret":{"type":"string","readOnly":true},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"user":{"$ref":"#/components/schemas/ItemRefDto"},"isReadonly":{"type":"boolean","description":"When enabled, this API key is restricted to safe, read-only HTTP methods (GET, HEAD, OPTIONS, TRACE) and cannot perform writes","default":false},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","status","user","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/api-keys":{"post":{"operationId":"ApiKeysController_createApiKey","parameters":[],"requestBody":{"required":true,"description":"The `ApiKey` to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyDto"}}}},"responses":{"201":{"description":"Returns an `ApiKey`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyDto"}}}},"422":{"description":"Returns an `ErrorDto` in case of validation errors or failures.
"}},"tags":["Api Keys"]}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.podplay.app/api/configuration/api-keys.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.