Sign in
Project

Create a Project API Key

Create a project API key. Requires project:api_keys:write; project keys cannot create other keys. If you cannot grant a selected permission, the request returns 403 without creating a key. Each successful request creates a new key. Store the returned secret securely.

post/v2/projects/{projectId}/api-keys

Path parameters

projectIdstring required

Headers

gt-api-version'2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1'

API contract version. Defaults to the oldest supported version.

API contract version. Defaults to the oldest supported version.

Request body

namestring required

Key name, 1–255 characters after trimming.

permissionsProjectApiKeyPermission[]

Project permissions to grant. Select at least one, or omit to grant all project permissions you can delegate. You must hold every selected permission. Duplicates are ignored. Write permissions do not include Read.

type'production' | 'development'

Ignored. All new keys are project-scoped API keys for any environment.

Response

Project API key created

Changes

Changed in 5 of the 15 revisions of this API.8

  • 4587bc8b9f531See the full diff
    • ○

      the endpoint scheme security UserBearerAuth was removed from the API

      api-security-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7c34a030bead1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 7b0d929796914See the full diff
    • ○

      the request property default value production was removed

      request-property-default-value-removed

    • ○

      request property deprecated

      request-property-deprecated

    • ○

      response property apiKey/type deprecated

      response-property-deprecated

    • ○

      removed the development enum value from the / response property for the response status

      response-property-enum-value-removed

  • 1f85b18923421See the full diff
    • ○

      the endpoint scheme security UserBearerAuth was added to the API

      api-security-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 451f820cc1971See the full diff
    • ○

      endpoint added

      endpoint-added