API Keys

Get all API keys associated with a company

Securityoauth2 or bearerAuth or apiKeyHeader
Request
query Parameters
status
string
Default: "active"
Enum: "active" "inactive"
limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

offset
integer >= 0

Offset from the start of results.

Responses
200

Success

get/keys
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Create an API key associated with a company

Securityoauth2 or bearerAuth or apiKeyHeader
Request
Request Body schema: application/json
required

The company app domain data

userId
required
string
whitelistedIPs
Array of strings or null (WhitelistedIPs)

A list of command separated IP addresses or CIDR blocks to which to restrict access to this API key. For example: 1.1.1.1,2.2.2.2,10.10.0.0/16

Responses
201

Created

post/keys
Request samples
application/json
{
  • "userId": "string",
  • "whitelistedIPs": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "userId": "string",
  • "key": "string",
  • "whitelistedIPs": [
    ],
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z"
}

Get an API key associated with a company

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
keyId
required
string

The API key id.

Responses
200

Success

get/keys/{keyId}
Response samples
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "userId": "string",
  • "key": "string",
  • "whitelistedIPs": [
    ],
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z"
}

Delete an API key associated with a company

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
keyId
required
string

The API key id.

Responses
204

Success

delete/keys/{keyId}