Create a new API key

Use when issuing a new API key (e.g. for a service account or for the current user). Provide service_account_id to create for a service account.

POST /secrets/api/keys

Create a new API key

cURL

curl --request POST \
  --url https://us.api.flexprice.io/v1/secrets/api/keys \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "type": "private_key",
  "expires_at": "<string>",
  "service_account_id": "<string>"
}
'

201

{
  "api_key": "<string>",
  "secret": {
    "created_at": "<string>",
    "display_id": "<string>",
    "expires_at": "<string>",
    "id": "<string>",
    "last_used_at": "<string>",
    "name": "<string>",
    "provider": "flexprice",
    "roles": [
      "<string>"
    ],
    "status": "published",
    "type": "private_key",
    "updated_at": "<string>",
    "user_type": "user"
  }
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

API key creation request

name · string · required

type · enum<string> · required

Available options: private_key, publishable_key, integration

expires_at · string

service_account_id · string

Response

201

application/json

Created

api_key · string

secret · object

Show child attributes