The Api Key Resource

Attributes
  • id
    string

    The ID of the API key.

  • name
    string

    The name of the API key.

  • creator
    object
    includable

    A creator object. Describes who created the resource.

    Show child fields
  • hub_id
    string

    The hub id of that the API key will be made for.

  • secret
    string
    optional

    If there is a secret the information will be displayed here.

  • permissions
    object

    Environment permission information for this API key.

    Show child fields
  • capabilities
    array of strings
    optional

    An Array of Capabilities.

  • ips
    array of strings | null

    Add an array of approved IPs that can make requests using the API key.

  • state
    object

    Information regarding the current state of the api-key.

    Show child fields
  • events
    object

    A collection of timestamps for each event in the api-key's lifetime.

    Show child fields
Example
{
"id": "5cb964ed4fde4d0001d05cc7",
"name": "MainHubKey",
"creator": {
"type": "account",
"id": "5cb964ed4fde4d0001d05cc7"
},
"hub_id": "5cb964ed4fde4d0001d05cc7",
"secret":
" SECRET"
,
"permissions": {
"all_environments": false,
"environments": [
{
"id": "5b9c2a77b6393d0001eb45fd",
"manage": false
}
]
},
"capabilities": {
"all": false,
"specific": [
"dns-view",
"containers-volumes-view",
"environments-view",
"images-view",
"servers-view",
"stacks-view"
]
},
"ips": [
"185.32.2.3",
"24.24.1.2",
"8.2.1.4",
"3.2.12.42"
],
"state": {
"current": "live",
"changed": "2018-09-14T21:39:03.096Z"
},
"events": {
"created": "2018-09-14T21:39:03.096Z",
"updated": "2018-09-17T16:50:54.107Z",
"deleted": "0001-01-01T00:00:00Z"
}
}