Chilkat Online Tools

TCL / Cognite API v1 / List API keys

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateString $queryParams "all" "false"
CkJsonObject_UpdateString $queryParams "includeDeleted" "false"

CkHttp_SetRequestHeader $http "api-key" "{{api-key}}"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://domain.com/api/v1/projects/{{project}}/apikeys" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $queryParams

Curl Command

curl -G -d "all=false"
	-d "includeDeleted=false"
	-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/apikeys

Postman Collection Item JSON

{
  "id": "getApiKeys",
  "name": "List API keys",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "apikeys"
      ],
      "query": [
        {
          "key": "all",
          "description": "Only available with users:list ACL, returns all API keys for the project.",
          "value": "false",
          "disabled": true
        },
        {
          "key": "serviceAccountId",
          "description": "Get API keys for a specific service account, only available to admin users.",
          "disabled": true
        },
        {
          "key": "includeDeleted",
          "description": "Whether to include deleted API keys, or not.\nDeleted API keys can be listed for up to 90 days after deletion.\n",
          "value": "false",
          "disabled": true
        }
      ],
      "variable": [
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      }
    ],
    "description": "Retrieves a list of all API keys connected to the current service account. Administrators can optionally list keys for all or individual service accounts that are not their own."
  }
}