Create an API Key

POST /api_keys

You can create mulitple API keys for your organization. All API keys operate on either Live or Test modes.

Headers

Authorization string Required

Authorize your API calls with an Arta API token

application/json

Body

api_key object Required

Additional properties are allowed.
Hide api_key attribute Show api_key attribute object
- is_testing boolean
  
  Whether this API Key should operate in Live or Test mode.
  
  Default value is false.

Responses

201 application/json

The created API Key
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attributes Show response attributes object
- created_at string
- id integer(int64)
- is_testing boolean
  
  Default value is false.
- token string
- updated_at string
400 application/json

Bad Request
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attribute Show response attribute object
- errors object
  
  Additional properties are allowed.
  
  Hide errors attribute Show errors attribute object
  
  detail string

POST /api_keys

curl \
 -X POST https://api.arta.io/api_keys \
 -H "Content-Type: application/json" \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
 -d '{"api_key":{"is_testing":true}}'

Request examples

# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y

# Payload
{
  "api_key": {
    "is_testing": true
  }
}

Response examples (201)

# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "created_at": "2021-01-21T17:22:08.818747",
  "id": 2,
  "is_testing": false,
  "token": "******************eQ0Rqp",
  "updated_at": "2021-01-21T17:22:08.818747"
}

Response examples (400)

# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "errors": {
    "detail": "string"
  }
}