API Keys

List API Keys

get

Return a list of all API Keys.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of Requested API Keys

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/api-keys

HTTPcURLJavaScriptPython

GET /api/v1/api-keys HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "appname": "my_application",
      "description": "API Key for my application",
      "roles": [
        "app_admin"
      ],
      "last_login": 1691164160466,
      "last_ip": "127.0.0.1"
    }
  ]
}

Create API Key

post

Create an API Key from the supplied object.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

API Key Create Config

appnamestringRequired

API Key Name

Example: my_application

descriptionstringOptional

API Key Description

Example: API Key for my application

rolesstring[]Required

An array containing strings which include the role name the user should be assigned to.

Example: ["app_admin"]

Responses

201

Object of a Requested API Key

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

post

/api/v1/api-keys

HTTPcURLJavaScriptPython

POST /api/v1/api-keys HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "appname": "my_application",
  "description": "API Key for my application",
  "roles": [
    "app_admin"
  ]
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "appkey": "fMBQnzyGRnHuTEjhOclqZwHTPh7dBP1MkZtV",
    "appname": "my_application",
    "description": "API Key for my application",
    "roles": [
      "app_admin"
    ],
    "last_login": 1691164160466,
    "last_ip": "127.0.0.1"
  }
}

Get API Key

get

Fetches a specific API Key from the appname supplied in the path.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

appnamestringRequired

String appname of the API Key to get

Responses

200

Object of a Requested API Key

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/api-keys/{appname}

HTTPcURLJavaScriptPython

GET /api/v1/api-keys/{appname} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "appname": "my_application",
    "description": "API Key for my application",
    "roles": [
      "app_admin"
    ],
    "last_login": 1691164160466,
    "last_ip": "127.0.0.1"
  }
}

Update API Key

put

Update a API Key given the provided object. This does not do a diff. You must send the complete object.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

appnamestringRequired

String appname of the API Key to get

Body

application/json

API Key Update Config

descriptionstringOptional

API Key Description

Example: API Key for my application

rolesstring[]Optional

An array containing strings which include the role name the user should be assigned to.

Example: ["app_admin"]

Responses

200

Object of a Requested API Key

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

put

/api/v1/api-keys/{appname}

HTTPcURLJavaScriptPython

PUT /api/v1/api-keys/{appname} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "description": "API Key for my application",
  "roles": [
    "app_admin"
  ]
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "appname": "my_application",
    "description": "API Key for my application",
    "roles": [
      "app_admin"
    ],
    "last_login": 1691164160466,
    "last_ip": "127.0.0.1"
  }
}

Delete API Key

delete

Deletes the API Key

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

appnamestringRequired

String appname of the API Key to get

Responses

204

An empty array

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

delete

/api/v1/api-keys/{appname}

HTTPcURLJavaScriptPython

DELETE /api/v1/api-keys/{appname} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update API Key

put

Update a API Key given the provided object. This does not do a diff. You must send the complete object.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

appnamestringRequired

String appname of the API Key to get

Body

application/json

API Key Update Config

descriptionstringOptional

API Key Description

Example: API Key for my application

rolesstring[]Optional

An array containing strings which include the role name the user should be assigned to.

Example: ["app_admin"]

Responses

200

Object of a Requested API Key

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

put

/api/v1/api-keys/{appname}/regen

HTTPcURLJavaScriptPython

PUT /api/v1/api-keys/{appname}/regen HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "description": "API Key for my application",
  "roles": [
    "app_admin"
  ]
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "appkey": "fMBQnzyGRnHuTEjhOclqZwHTPh7dBP1MkZtV",
    "appname": "my_application",
    "description": "API Key for my application",
    "roles": [
      "app_admin"
    ],
    "last_login": 1691164160466,
    "last_ip": "127.0.0.1"
  }
}