PUT /v1/accessKeys/{id}

Updates the properties of existing accessKey by accessId. It can be used to enable or disable the access key and to update the corsHeaders list.

Servers

Path parameters

Name Type Required Description
id String Yes

The accessId of the access key to update.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
scopes[] Array No

Scopes assigned to the key.

Note: Updates to scopes will take up to 5m to reflect due to caching in the system.

Alerting

  • adminMonitorsV2
  • viewMonitorsV2
  • manageMonitorsV2

Data Management

  • manageApps
  • viewCollectors
  • manageCollectors
  • viewConnections
  • manageConnections
  • contentAdmin
  • viewFieldExtractionRules
  • manageFieldExtractionRules
  • viewFields
  • manageFields
  • manageBudgets
  • viewLibrary
  • manageLibrary
  • viewPartitions
  • managePartitions
  • manageS3DataForwarding
  • viewScheduledViews
  • manageScheduledViews
  • manageTokens

Logs

  • runLogSearch

Metrics

  • runMetricsQuery

Reliability Management

  • viewSlos
  • manageSlos

Security

  • manageAccessKeys
  • viewPersonalAccessKeys
  • managePersonalAccessKeys

UserManagement

  • viewUsersAndRoles
  • manageUsersAndRoles
disabled Boolean Yes

Indicates whether the access key is disabled or not.

corsHeaders[] Array No

An array of domains for which the access key is valid. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:

  1. Requests with an ORIGIN header but the allowlist is empty.
  2. Requests with an ORIGIN header that don't match any entry in the allowlist.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.