Secrets

Read Secret

Changed on
get/secrets/{secret_id_or_slug}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/secrets/{secret_id_or_slug}
  • Auth
    API key in header Authorization

Path parameters

secret_id_or_slugstring required

Query parameters

scope'project' | 'organization'

Response

Successful Response

slugstring nullable
idstring uuid nullable
kind'provider_key' | 'custom_provider' | 'sso_provider' | 'webhook_provider' | 'custom_secret' | 'channel_secret' | 'subscription_provider' | 'oauth_provider' | 'oauth_grant' required
write_onlyboolean
availability'all_projects' | 'selected_projects'
selected_project_idsstring[] nullable

Changes

  • c73e2d6d0d56Revision changes
    • info

      added the new optional query request parameter scope

    • 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

  • 1d98cd0e4892Revision changes
    • warning

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