Account5

Action36

Action Item12

Action Item Category5

Action Item Comment2

Agent3

Announcements6

API keys5

Application4

Approval6

Artifact7

Asset4

Authentication1

Build4

Catalog instance (multiple keys)3

Catalog instance (single key)4

Catalog specification5

Category2

Channel5

Checklist6

Custom domain5

Deployment4

Deployment group4

Deployment strategy5

Dimension5

Dimension value1

Dimension Value4

Entity hook8

Event3

Inbox rules12

Link12

Log config4

Log specification5

Log template4

Namespace5

NRN5

Organization2

Package10

Parameter11

Personal access tokens5

Policy5

Provider6

Provider Specification5

Query1

Release4

Report versions8

Reports6

Role and grant5

Runtime Configuration5

Scope10

Scope type5

Service15

Suggestion8

Technology template5

User4

Workflow aliases7

Workflow definitions7

Workflow engine1

Workflow executions10

Workflow plugins2

Workflow revisions2

Workflow secrets and variables5

Workflow signals3

Workflow triggers1

API keys

Create an API key

Changed on Oct 15, 2026

Creates a new API key.

post/api_key

Request

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

Request body

namestring required

A descriptive name for the API key.

Example request

{
  "name": "my-machine-process-that-will-access-nullplatform",
  "grants": [
    {
      "nrn": "organization=1:account=1:namespace=1:application=4",
      "role_slug": "machine:ci"
    }
  ],
  "tags": [
    {
      "key": "CI",
      "value": "main"
    }
  ]
}

Response

The operation was successful.

idinteger required

Unique ID for the API key.

namestring required

The descriptive name given to the API key.

api_keystring required

Your newly created API key.

⚠️ Save your API key securely.

The API key value will be displayed only once. Make sure to store it in a secure location as it cannot be retrieved later.

masked_api_keystring nullable

Your masked API key.

owner_idinteger

The unique ID of the user that creates the API key.

last_used_atstring date-time nullable

The ISO-8601 UTC timestamp of when the API key was last used.

created_atstring date-time required

The ISO-8601 UTC timestamp of when the API key was created.

updated_atstring date-time required

The ISO-8601 UTC timestamp of when the API key was last updated.

Example response

{
  "id": 1234,
  "name": "CI/CD Main",
  "api_key": "AAAA.1234567890abcdef1234567890abcdefPTs=",
  "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

Oct 15, 2026728d4df70ca1 Revision 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
Sep 29, 202660d632cf92af Revision changes
- info
  added to the / request property oneOf list
- 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

Operation history