DEdefaulr
ApiKeys

Create an API key

Changed on

Create a new personal API key for the authenticated user. The full key value is only returned in this response and cannot be retrieved again, so it should be stored securely.

post/apiKeys.create

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/apiKeys.create
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

namestring required

A name to identify the API key.

expiresAtstring date-time

An optional date and time when the key should expire.

scopestring[]

An optional list of scopes to restrict which endpoints the key can access.

Response

OK

Changes