SIsilverflow
API Keys

Create API Key

This operation creates a new API key with the specified permissions. When the status is set to active the API Key is immediately usable.

Requires apiKeys:Create permission.

post/apiKeys

Request

Request body

status'disabled' | 'active' | 'archived'

The status of an API Key

descriptionstring
permissionsPermission[] required
ipRangesIpRange[]

A list of IP ranges

Example request

{
  "status": "disabled",
  "description": "API key for merchant management",
  "permissions": [
    "reports:All"
  ],
  "ipRanges": [
    "185.184.111.39/32"
  ]
}

Response

The created API Key

keystring required

Uniquely identifies an API Key

status'disabled' | 'active' | 'archived' required

The status of an API Key

agentKeystring required

Uniquely identifies an Agent

descriptionstring
permissionsPermission[] required
ipRangesIpRange[]

A list of IP ranges

mtlsEnabledboolean

Whether this API Key requires mTLS. It is false unless it was enabled, and it can't be set back to false. <a class="experimental-tag-link" href="https://docs.silverflow.com/guides/api-lifecycle#tag/EXPERIMENTAL-Tag"><span class="tag experimental-tag">EXPERIMENTAL</span></a>

secretstring

The secret part of this API Key. This value will only be returned upon creation. It cannot be changed afterwards.

createdstring date-time required

The date and time this object was created

lastModifiedstring date-time

The date and time this object was last modified

versioninteger required

The version of this object

Example response

{
  "key": "apk-1nM6msvaara1OMHzU7Zd",
  "status": "active",
  "agentKey": "cgt-6y5t4r3edcgfrthb",
  "description": "API Key for the data lake",
  "permissions": [
    "reports:All"
  ],
  "ipRanges": [
    "185.184.111.39/32"
  ],
  "created": "2021-05-27T10:57:52Z",
  "lastModified": "2021-05-27T10:57:52Z",
  "version": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.