NUnullplatform
API keys

List API keys

Changed on

Lists all API keys.

get/api_key

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/api_key
  • Auth
    HTTP bearer

Query parameters

owner_idinteger

Filter API keys by owner ID.

namestring

Filter API keys by name. Supports case-insensitive partial string matches. For example, searching for 'alex' will match names like 'Alex doe', 'alex123', or 'alex-xyz'.

Response

The operation was successful.

Example response

{
  "paging": {
    "limit": 10
  },
  "results": [
    {
      "id": 1234,
      "name": "CI/CD Main",
      "masked_api_key": "AAAA.xxxxxxxxxxxxxxxxxxxxxPTs=",
      "tags": [
        {
          "key": "CI",
          "value": "main"
        }
      ],
      "grants": [
        {
          "nrn": "organization=1:account=1:namespace=1:application=4",
          "role_id": 1855672260,
          "role_slug": "machine:ci",
          "actions": [
            "application:read",
            "deployment:create"
          ],
          "inherits": [
            {
              "id": 1855672260,
              "slug": "ops",
              "organization_id": 1
            }
          ],
          "added": [
            "application:delete"
          ],
          "removed": [
            "deployment:create"
          ]
        }
      ],
      "owner_id": 1595,
      "last_used_at": "2021-01-02T00:00:00Z",
      "created_at": "2021-01-02T00:00:00Z",
      "updated_at": "2021-01-02T00:00:00Z"
    }
  ]
}

Changes

  • 728d4df70ca1Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 60d632cf92afRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status