Skip to content
Docs

Global Config

Read and update Global Config items, manage read tokens, and restore backups.

Creates a Global Config.

Parameters

ParameterTypeRequiredDescription
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.
requestBodyobjectYesRequest body for this tool.

Adds a token to an existing Global Config.

Parameters

ParameterTypeRequiredDescription
edgeConfigIdstringYesThe Global Config ID.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.
requestBodyobjectYesRequest body for this tool.

Returns a Global Config.

Parameters

ParameterTypeRequiredDescription
edgeConfigIdstringYesThe Global Config ID.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.

Retrieves a specific version of a Global Config from backup storage.

Parameters

ParameterTypeRequiredDescription
edgeConfigIdstringYesThe Global Config ID.
edgeConfigBackupVersionIdstringYesThe Global Config backup version ID.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.

Returns backups of a Global Config.

Parameters

ParameterTypeRequiredDescription
edgeConfigIdstringYesThe Global Config ID.
nextstringNo-
limitnumberNoMinimum: 0. Maximum: 50.
metadatastringNo-
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.

Returns a specific Global Config Item.

Parameters

ParameterTypeRequiredDescription
edgeConfigIdstringYesThe Global Config ID.
edgeConfigItemKeystringYesThe Global Config item key.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.

Returns all items of a Global Config.

Parameters

ParameterTypeRequiredDescription
edgeConfigIdstringYesThe Global Config ID.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.

Return meta data about a Global Config token.

Parameters

ParameterTypeRequiredDescription
edgeConfigIdstringYesThe Global Config ID.
tokenstringYesThe Global Config token.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.

Returns all tokens of a Global Config.

Parameters

ParameterTypeRequiredDescription
edgeConfigIdstringYesThe Global Config ID.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.

Returns all Global Configs.

Parameters

ParameterTypeRequiredDescription
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.

Update multiple Global Config Items in batch.

Parameters

ParameterTypeRequiredDescription
edgeConfigIdstringYesThe Global Config ID.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.
requestBodyobjectNoRequest body for this tool.

Restores a Global Config backup.

Parameters

ParameterTypeRequiredDescription
edgeConfigIdstringYesThe Global Config ID.
edgeConfigBackupVersionIdstringYesThe Global Config backup version ID.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.
requestBodyunknownNoRequest body for this tool.

Updates a Global Config.

Parameters

ParameterTypeRequiredDescription
edgeConfigIdstringYesThe Global Config ID.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.
requestBodyobjectYesRequest body for this tool.

Was this helpful?

supported.