Documentation Index Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /doppler-admin | Type: Application | PCID required: Yes
doppler_admin_activity_logs_list
List
Parameters:
Parameter Type Required Default Description pageinteger No — Page number per_pageinteger No — Items per page
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"page" : {
"type" : "integer" ,
"description" : "Page number"
},
"per_page" : {
"type" : "integer" ,
"description" : "Items per page"
}
},
"required" : [
"PCID"
]
}
doppler_admin_activity_logs_retrieve
Retrieve
Parameters:
Parameter Type Required Default Description logstring Yes — Unique identifier for the log object.
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"log" : {
"type" : "string" ,
"description" : "Unique identifier for the log object."
}
},
"required" : [
"PCID" ,
"log"
]
}
doppler_admin_auth_me
Me
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
doppler_admin_auth_oidc
OIDC (Service Account Identity)
Parameters:
Parameter Type Required Default Description identitystring Yes — Identity ID from the Doppler Dashboard tokenstring Yes — the OIDC token string from your OIDC provider (likely CI)
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"identity" : {
"type" : "string" ,
"description" : "Identity ID from the Doppler Dashboard"
},
"token" : {
"type" : "string" ,
"description" : "the OIDC token string from your OIDC provider (likely CI)"
}
},
"required" : [
"PCID" ,
"identity" ,
"token"
]
}
doppler_admin_auth_revoke
Revoke
Parameters:
Parameter Type Required Default Description tokenstring Yes — The token value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"token" : {
"type" : "string" ,
"description" : "The token value"
}
},
"required" : [
"PCID" ,
"token"
]
}
doppler_admin_change_request_policies_create
Create
Parameters:
Parameter Type Required Default Description descriptionstring No — An optional description of the policy. namestring Yes — The name of the policy. rulesobject[] Yes — A list of rules the policy enforces. targetsobject Yes — Describes the which projects, environments, and configs the policy applies to.
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"description" : {
"type" : "string" ,
"description" : "An optional description of the policy."
},
"name" : {
"type" : "string" ,
"description" : "The name of the policy."
},
"rules" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "A list of rules the policy enforces."
},
"targets" : {
"type" : "object" ,
"description" : "Describes the which projects, environments, and configs the policy applies to." ,
"properties" : {
"allProjects" : {
"type" : "boolean" ,
"description" : "If true, the policy will apply to every config in the workplace."
},
"projects" : {
"type" : "object" ,
"description" : "A dictionary where the key is the project name, and the value contains information about what within the project the policy should apply to."
}
}
}
},
"required" : [
"PCID" ,
"name" ,
"rules" ,
"targets"
]
}
doppler_admin_change_request_policies_delete
Delete
Parameters:
Parameter Type Required Default Description slugstring Yes — The unique identifier of the policy.
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"slug" : {
"type" : "string" ,
"description" : "The unique identifier of the policy."
}
},
"required" : [
"PCID" ,
"slug"
]
}
doppler_admin_change_request_policies_get
Retrieve
Parameters:
Parameter Type Required Default Description slugstring Yes — Unique id of the policy
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"slug" : {
"type" : "string" ,
"description" : "Unique id of the policy"
}
},
"required" : [
"PCID" ,
"slug"
]
}
doppler_admin_change_request_policies_list
List
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
doppler_admin_change_request_policies_update
Update
Parameters:
Parameter Type Required Default Description slugstring Yes — The unique identifier of the policy. descriptionstring No — An optional description of the policy. namestring Yes — The name of the policy. rulesobject[] Yes — A list of rules the policy enforces. targetsobject Yes — Describes the which projects, environments, and configs the policy applies to.
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"slug" : {
"type" : "string" ,
"description" : "The unique identifier of the policy."
},
"description" : {
"type" : "string" ,
"description" : "An optional description of the policy."
},
"name" : {
"type" : "string" ,
"description" : "The name of the policy."
},
"rules" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "A list of rules the policy enforces."
},
"targets" : {
"type" : "object" ,
"description" : "Describes the which projects, environments, and configs the policy applies to." ,
"properties" : {
"allProjects" : {
"type" : "boolean" ,
"description" : "If true, the policy will apply to every config in the workplace."
},
"projects" : {
"type" : "object" ,
"description" : "A dictionary where the key is the project name, and the value contains information about what within the project the policy should apply to."
}
}
}
},
"required" : [
"PCID" ,
"slug" ,
"name" ,
"rules" ,
"targets"
]
}
doppler_admin_delete_v3workplacechange_requestschange_request_change_request_id_unitsunit_unit_id_review
DELETE /v3/workplace/change_requests/change_request/{change_request_id}/units/unit/{unit_id}/review
Parameters:
Parameter Type Required Default Description change_request_idstring Yes — Change Request Id unit_idstring Yes — Unit Id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"change_request_id" : {
"type" : "string" ,
"description" : "Change Request Id"
},
"unit_id" : {
"type" : "string" ,
"description" : "Unit Id"
}
},
"required" : [
"PCID" ,
"change_request_id" ,
"unit_id"
]
}
doppler_admin_get_options
Get Options
Parameters:
Parameter Type Required Default Description integrationstring Yes — The integration slug
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integration" : {
"type" : "string" ,
"description" : "The integration slug"
}
},
"required" : [
"PCID" ,
"integration"
]
}
doppler_admin_get_v3workplacechange_requests
GET /v3/workplace/change_requests
Parameters:
Parameter Type Required Default Description pageinteger No — Page number for pagination per_pageinteger No — Number of results per page statusstring[] No — The status value titlestring No — The title value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"page" : {
"type" : "integer" ,
"description" : "Page number for pagination"
},
"per_page" : {
"type" : "integer" ,
"description" : "Number of results per page"
},
"status" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "The status value"
},
"title" : {
"type" : "string" ,
"description" : "The title value"
}
},
"required" : [
"PCID"
]
}
doppler_admin_get_v3workplacechange_requestschange_request_change_request_id
GET /v3/workplace/change_requests/change_request/{change_request_id}
Parameters:
Parameter Type Required Default Description change_request_idstring Yes — Change Request Id revealstring No — Whether to reveal secret values. If defined, any value except “false” is treated as true
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"change_request_id" : {
"type" : "string" ,
"description" : "Change Request Id"
},
"reveal" : {
"type" : "string" ,
"description" : "Whether to reveal secret values. If defined, any value except \" false \" is treated as true"
}
},
"required" : [
"PCID" ,
"change_request_id"
]
}
doppler_admin_get_v3workplacechange_requestschange_request_change_request_id_unitsunit_unit_id
GET /v3/workplace/change_requests/change_request/{change_request_id}/units/unit/{unit_id}
Parameters:
Parameter Type Required Default Description revealstring No — Whether to reveal secret values. If defined, any value except “false” is treated as true change_request_idstring Yes — Change Request Id unit_idstring Yes — Unit Id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"reveal" : {
"type" : "string" ,
"description" : "Whether to reveal secret values. If defined, any value except \" false \" is treated as true"
},
"change_request_id" : {
"type" : "string" ,
"description" : "Change Request Id"
},
"unit_id" : {
"type" : "string" ,
"description" : "Unit Id"
}
},
"required" : [
"PCID" ,
"change_request_id" ,
"unit_id"
]
}
doppler_admin_integrations_create
Create
Parameters:
Parameter Type Required Default Description dataobject No — The authentication data for the integration namestring Yes — The name of the integration typestring Yes — The integration type
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"data" : {
"type" : "object" ,
"description" : "The authentication data for the integration"
},
"name" : {
"type" : "string" ,
"description" : "The name of the integration"
},
"type" : {
"type" : "string" ,
"description" : "The integration type"
}
},
"required" : [
"PCID" ,
"name" ,
"type"
]
}
doppler_admin_integrations_delete
Delete
Parameters:
Parameter Type Required Default Description integrationstring Yes — The slug of the integration to delete
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integration" : {
"type" : "string" ,
"description" : "The slug of the integration to delete"
}
},
"required" : [
"PCID" ,
"integration"
]
}
doppler_admin_integrations_get
Retrieve
Parameters:
Parameter Type Required Default Description integrationstring Yes — The integration slug
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integration" : {
"type" : "string" ,
"description" : "The integration slug"
}
},
"required" : [
"PCID" ,
"integration"
]
}
doppler_admin_integrations_list
List
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
doppler_admin_integrations_update
Update
Parameters:
Parameter Type Required Default Description integrationstring Yes — The slug of the integration to update dataobject No — The new authentication data for the integration namestring No — The new name of the integration
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integration" : {
"type" : "string" ,
"description" : "The slug of the integration to update"
},
"data" : {
"type" : "object" ,
"description" : "The new authentication data for the integration"
},
"name" : {
"type" : "string" ,
"description" : "The new name of the integration"
}
},
"required" : [
"PCID" ,
"integration"
]
}
doppler_admin_post_v3workplacechange_requests
POST /v3/workplace/change_requests
Parameters:
Parameter Type Required Default Description assignedobject[] Yes — The assigned value descriptionstring No — The description value titlestring Yes — The title value unitsobject[] Yes — The units value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"assigned" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The assigned value"
},
"description" : {
"type" : "string" ,
"description" : "The description value"
},
"title" : {
"type" : "string" ,
"description" : "The title value"
},
"units" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The units value"
}
},
"required" : [
"PCID" ,
"assigned" ,
"title" ,
"units"
]
}
doppler_admin_post_v3workplacechange_requestschange_request_change_request_id
POST /v3/workplace/change_requests/change_request/{change_request_id}
Parameters:
Parameter Type Required Default Description change_request_idstring Yes — Change Request Id assignedobject[] No — The assigned value descriptionstring No — The description value titlestring No — The title value unitsobject[] No — The units value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"change_request_id" : {
"type" : "string" ,
"description" : "Change Request Id"
},
"assigned" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The assigned value"
},
"description" : {
"type" : "string" ,
"description" : "The description value"
},
"title" : {
"type" : "string" ,
"description" : "The title value"
},
"units" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The units value"
}
},
"required" : [
"PCID" ,
"change_request_id"
]
}
doppler_admin_post_v3workplacechange_requestschange_request_change_request_id_close
POST /v3/workplace/change_requests/change_request/{change_request_id}/close
Parameters:
Parameter Type Required Default Description change_request_idstring Yes — Change Request Id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"change_request_id" : {
"type" : "string" ,
"description" : "Change Request Id"
}
},
"required" : [
"PCID" ,
"change_request_id"
]
}
doppler_admin_post_v3workplacechange_requestschange_request_change_request_id_unitsunit_unit_id_apply
POST /v3/workplace/change_requests/change_request/{change_request_id}/units/unit/{unit_id}/apply
Parameters:
Parameter Type Required Default Description change_request_idstring Yes — Change Request Id unit_idstring Yes — Unit Id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"change_request_id" : {
"type" : "string" ,
"description" : "Change Request Id"
},
"unit_id" : {
"type" : "string" ,
"description" : "Unit Id"
}
},
"required" : [
"PCID" ,
"change_request_id" ,
"unit_id"
]
}
doppler_admin_post_v3workplacechange_requestschange_request_change_request_id_unitsunit_unit_id_review
POST /v3/workplace/change_requests/change_request/{change_request_id}/units/unit/{unit_id}/review
Parameters:
Parameter Type Required Default Description change_request_idstring Yes — Change Request Id unit_idstring Yes — Unit Id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"change_request_id" : {
"type" : "string" ,
"description" : "Change Request Id"
},
"unit_id" : {
"type" : "string" ,
"description" : "Unit Id"
}
},
"required" : [
"PCID" ,
"change_request_id" ,
"unit_id"
]
}
doppler_admin_put_v3workplacechange_requestschange_request_change_request_id_assignees
PUT /v3/workplace/change_requests/change_request/{change_request_id}/assignees
Parameters:
Parameter Type Required Default Description change_request_idstring Yes — Change Request Id assignedobject[] Yes — The assigned value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"change_request_id" : {
"type" : "string" ,
"description" : "Change Request Id"
},
"assigned" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The assigned value"
}
},
"required" : [
"PCID" ,
"change_request_id" ,
"assigned"
]
}
doppler_admin_put_v3workplacechange_requestschange_request_change_request_id_unitsunit_unit_id_status
PUT /v3/workplace/change_requests/change_request/{change_request_id}/units/unit/{unit_id}/status
Parameters:
Parameter Type Required Default Description change_request_idstring Yes — Change Request Id unit_idstring Yes — Unit Id statusstring Yes — The status value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"change_request_id" : {
"type" : "string" ,
"description" : "Change Request Id"
},
"unit_id" : {
"type" : "string" ,
"description" : "Unit Id"
},
"status" : {
"type" : "string" ,
"description" : "The status value" ,
"enum" : [
"draft" ,
"open" ,
"canceled"
]
}
},
"required" : [
"PCID" ,
"change_request_id" ,
"unit_id" ,
"status"
]
}
doppler_admin_webhooks_add
Add
Parameters:
Parameter Type Required Default Description projectstring No — The project’s name authenticationobject No — The authentication value enableConfigsstring[] No — Config slugs that the webhook should be enabled for namestring No — The name of the webhook. payloadstring No — See: https://docs.doppler.com/docs/webhooks#default-payload secretstring No — See: https://docs.doppler.com/docs/webhooks#verify-webhook-with-request-signing urlstring Yes — The webhook URL. Must be https
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"project" : {
"type" : "string" ,
"description" : "The project's name"
},
"authentication" : {
"type" : "object" ,
"description" : "The authentication value" ,
"properties" : {
"type" : {
"type" : "string" ,
"description" : "The type value"
},
"token" : {
"type" : "string" ,
"description" : "Used when type = Bearer"
},
"username" : {
"type" : "string" ,
"description" : "Used when type = Basic"
},
"password" : {
"type" : "string" ,
"description" : "Used when type = Basic"
}
}
},
"enableConfigs" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Config slugs that the webhook should be enabled for"
},
"name" : {
"type" : "string" ,
"description" : "The name of the webhook."
},
"payload" : {
"type" : "string" ,
"description" : "See: https://docs.doppler.com/docs/webhooks#default-payload"
},
"secret" : {
"type" : "string" ,
"description" : "See: https://docs.doppler.com/docs/webhooks#verify-webhook-with-request-signing"
},
"url" : {
"type" : "string" ,
"description" : "The webhook URL. Must be https"
}
},
"required" : [
"PCID" ,
"url"
]
}
doppler_admin_webhooks_delete
Delete
Parameters:
Parameter Type Required Default Description projectstring No — The project’s name slugstring Yes — Webhook’s slug
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"project" : {
"type" : "string" ,
"description" : "The project's name"
},
"slug" : {
"type" : "string" ,
"description" : "Webhook's slug"
}
},
"required" : [
"PCID" ,
"slug"
]
}
doppler_admin_webhooks_disable
Disable
Parameters:
Parameter Type Required Default Description projectstring No — The project’s name slugstring Yes — Webhook’s slug
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"project" : {
"type" : "string" ,
"description" : "The project's name"
},
"slug" : {
"type" : "string" ,
"description" : "Webhook's slug"
}
},
"required" : [
"PCID" ,
"slug"
]
}
doppler_admin_webhooks_enable
Enable
Parameters:
Parameter Type Required Default Description projectstring No — The project’s name slugstring Yes — Webhook’s slug
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"project" : {
"type" : "string" ,
"description" : "The project's name"
},
"slug" : {
"type" : "string" ,
"description" : "Webhook's slug"
}
},
"required" : [
"PCID" ,
"slug"
]
}
doppler_admin_webhooks_get
Retrieve
Parameters:
Parameter Type Required Default Description slugstring Yes — Webhook’s slug projectstring No — The project’s name
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"slug" : {
"type" : "string" ,
"description" : "Webhook's slug"
},
"project" : {
"type" : "string" ,
"description" : "The project's name"
}
},
"required" : [
"PCID" ,
"slug"
]
}
doppler_admin_webhooks_list
List
Parameters:
Parameter Type Required Default Description projectstring No — The project’s name
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"project" : {
"type" : "string" ,
"description" : "The project's name"
}
},
"required" : [
"PCID"
]
}
doppler_admin_webhooks_update
Update
Parameters:
Parameter Type Required Default Description projectstring No — The project’s name slugstring Yes — Webhook’s slug authenticationobject No — The authentication value disableConfigsstring[] No — Config slugs that the webhook should be disabled for enableConfigsstring[] No — Config slugs that the webhook should be enabled for namestring No — Name of the webhook. payloadstring No — See: https://docs.doppler.com/docs/webhooks#default-payload secretstring No — See: https://docs.doppler.com/docs/webhooks#verify-webhook-with-request-signing urlstring No — The webhook URL. Must be https
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"project" : {
"type" : "string" ,
"description" : "The project's name"
},
"slug" : {
"type" : "string" ,
"description" : "Webhook's slug"
},
"authentication" : {
"type" : "object" ,
"description" : "The authentication value" ,
"properties" : {
"type" : {
"type" : "string" ,
"description" : "The type value"
},
"token" : {
"type" : "string" ,
"description" : "Used when type = Bearer"
},
"username" : {
"type" : "string" ,
"description" : "Used when type = Basic"
},
"password" : {
"type" : "string" ,
"description" : "Used when type = Basic"
}
}
},
"disableConfigs" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Config slugs that the webhook should be disabled for"
},
"enableConfigs" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Config slugs that the webhook should be enabled for"
},
"name" : {
"type" : "string" ,
"description" : "Name of the webhook."
},
"payload" : {
"type" : "string" ,
"description" : "See: https://docs.doppler.com/docs/webhooks#default-payload"
},
"secret" : {
"type" : "string" ,
"description" : "See: https://docs.doppler.com/docs/webhooks#verify-webhook-with-request-signing"
},
"url" : {
"type" : "string" ,
"description" : "The webhook URL. Must be https"
}
},
"required" : [
"PCID" ,
"slug"
]
}