Create api-key

POST 
/api/v1/partner/settings/api-keys

Create a new client API key with an optional route allowlist.

Request

application/json

Body

required

name stringrequired

Possible values: non-empty

full_access boolean

Default value: false

allowed_routes string[]

Possible values: non-empty

Default value: ``

Route ids (e.g. 'POST /api/v8/partner/documents') and/or preset tokens (e.g. 'preset:lens-sdk') this key may use; ignored when full_access is true. GET /api/v1/partner/settings/api-keys/available-permissions for the full list of valid values.

manager_ids integer[]

Default value: ``

expires_at date-time

Responses

201

An API key

application/json

Schema

Schema

id integerrequired
name (string | null)

Possible values: non-empty

key (string | null)

Possible values: non-empty

full_access booleanrequired
allowed_routes string[]required

Possible values: non-empty

status stringrequired

Possible values: non-empty

managers object[]
Array [
id integerrequired
name stringrequired
Possible values: non-empty
email stringrequired
Possible values: non-empty
is_owner booleanrequired
active booleanrequired
]
last_used_at date-time
expires_at date-time
created date-time

Example (from schema)

{
  "id": 0,
  "full_access": true,
  "allowed_routes": [
    "string"
  ],
  "status": "string",
  "managers": [
    {
      "id": 0,
      "name": "string",
      "email": "string",
      "is_owner": true,
      "active": true
    }
  ]
}

400

User error

application/json

Schema

Schema

oneOf

MALFORMED_PARAMETERS

status string

Default value: fail

error string

Default value: Malformed parameters

details undefined[]

Default value: [object Object]

Example (from schema)

{}

403

User error

application/json

Schema

Schema

oneOf

AUTHENTICATION_CREDENTIALS_WERE_NOT_PROVIDED

status string

Default value: fail

error string

Default value: Authentication credentials were not provided.

THIS_API_KEY_IS_NOT_PERMITTED_TO_ACCESS_THIS_ROUTE

status string

Default value: fail

error string

Default value: This API key is not permitted to access this route

Example (from schema)

{}

404

Not found

application/json

Schema

Schema

oneOf

NOT_FOUND

status string

Default value: fail

error string

Default value: Not found.

DOCUMENT_NOT_FOUND

status string

Default value: fail

error string

Default value: Document Not Found

Example (from schema)

{}

413

Request body too large

application/json

Schema

Schema

oneOf

REQUEST_BODY_TOO_LARGE

status string

Default value: fail

error string

Default value: Request body too large

Example (from schema)

{}

429

Rate limit

application/json

Schema

Schema

oneOf

YOU_HAVE_BEEN_RATE_LIMITED

status string

Default value: fail

error string

Default value: You have been rate limited

details undefined[]

Default value: [object Object]

Example (from schema)

{}

499

User error

application/json

Schema

Schema

oneOf

CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION

status string

Default value: fail

error string

Default value: Client closed request or lost connection

Example (from schema)

{}

500

Unexpected error

503

Service is temporarily unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORARILY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

Default value: Service is temporarily unavailable. Please try again later

Example (from schema)

{}

504

Gateway timeout. Returned if request takes more than 120 seconds. The request might finish successfully later.

application/json

Schema

Schema

oneOf

GATEWAY_TIMEOUT

status string

Default value: fail

error string

Default value: Gateway timeout

Example (from schema)

{}

default

General error response

application/json

Schema

Schema

status string

Default value: fail

error stringrequired
details object[]

Example (from schema)

{
  "status": "fail",
  "error": "string"
}

Loading...