SIsignificant-gravitas
v1
api-keys

Suspend API key

Changed on

Suspend an API key

post/api/api-keys/{key_id}/suspend

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

key_idstring required

Response

Successful Response

user_idstring required
scopesAPIKeyPermission[] required
type'api_key'
created_atstring date-time required
expires_atstring date-time nullable
last_used_atstring date-time nullable
revoked_atstring date-time nullable
organization_idstring nullable
team_id_restrictionstring nullable
idstring required
namestring required
headstring required

The first 8 characters of the key

tailstring required

The last 8 characters of the key

status'ACTIVE' | 'REVOKED' | 'SUSPENDED' required
descriptionstring nullable
owner_typestring nullable

Changes

  • 01f81870b54cRevision changes
    • warning

      added the new READ_CREDITS enum value to the / response property for the response status

    • warning

      added the new READ_FILES enum value to the / response property for the response status

    • warning

      added the new READ_LIBRARY enum value to the / response property for the response status

    • warning

      added the new READ_RUN enum value to the / response property for the response status

    • warning

      added the new READ_RUN_REVIEW enum value to the / response property for the response status

    • warning

      added the new READ_SCHEDULE enum value to the / response property for the response status

    • warning

      added the new RUN_AGENT enum value to the / response property for the response status

    • warning

      added the new SHARE_RUN enum value to the / response property for the response status

    • warning

      added the new WRITE_FILES enum value to the / response property for the response status

    • warning

      added the new WRITE_RUN enum value to the / response property for the response status

    • warning

      added the new WRITE_RUN_REVIEW enum value to the / response property for the response status

    • warning

      added the new WRITE_SCHEDULE enum value to the / response property for the response status

    • warning

      added the new WRITE_STORE enum value to the / response property for the response status

  • 183f82172fecRevision 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