Get API Keys

GET 
/sites/:siteId/apiKeys

Returns the list of ApiKeys

Request

Path Parameters

siteId stringrequired

Site Identifier

Query Parameters

next string

Next page of results token

limit string
Limit Results
Default value: 10

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

next string

Next page of results token

apiKeys

object[]

List of ApiKeys

Array [

name string

Name of API Key

apiKey string

API Key value

userId string

siteId string

insertedDate string

Inserted Timestamp

permissions string[]

List of permissions

Possible values: [READ, WRITE, DELETE, GOVERN]

]

Example (from schema)

{
  "next": "string",
  "apiKeys": [
    {
      "name": "string",
      "apiKey": "string",
      "userId": "string",
      "siteId": "string",
      "insertedDate": "string",
      "permissions": [
        "READ"
      ]
    }
  ]
}

Loading...