diff --git a/docs/index.html b/docs/index.html index 31fc0e53d..39bdbee33 100644 --- a/docs/index.html +++ b/docs/index.html @@ -463,7 +463,7 @@ -
SpaceCat logo

Enable or disable audits for sites

https://spacecat.experiencecloud.live/api/v1/configurations/{version}

Response samples

Content type
application/json
{
  • "version": "string",
  • "jobs": [
    ],
  • "queues": {
    },
  • "sandboxAudits": {
    }
}

Enable or disable audits for sites

Use this endpoint to enable or disable specific audit types for your sites.

Authorizations:
admin_key
Request Body schema: application/json
required
Array
baseURL
required
string <url> (URL)
auditType
required
string

The type of audit to be enabled or disabled.

@@ -2703,7 +2727,31 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">

Development server

https://spacecat.experiencecloud.live/api/ci/configurations/sites/audits

Production server

-
https://spacecat.experiencecloud.live/api/v1/configurations/sites/audits

Request samples

Content type
application/json
[]

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string"
}

brands

Retrieves brands for an organization

https://spacecat.experiencecloud.live/api/v1/configurations/sites/audits

Request samples

Content type
application/json
[]

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string"
}

Update sandbox audit configurations

Updates the configuration settings for sandbox audit types. This endpoint allows +administrators to enable/disable specific audit types for sandbox sites and set +their expiration times. Only the audit types provided in the request will be updated.

+
Authorizations:
admin_key
Request Body schema: application/json
required
required
object (SandboxAuditsConfig)

Sandbox audit configurations to update

+

Responses

Request samples

Content type
application/json
Example
{
  • "sandboxConfigs": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Sandbox configurations updated successfully",
  • "updatedConfigs": {
    },
  • "totalUpdated": 2
}

brands

Retrieves brands for an organization

This endpoint provide a list of brands the user have access to in the given organization.

Authorizations:
ims_key
path Parameters
organizationId
required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000

The organization ID in uuid format

@@ -3819,7 +3867,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">

Production server

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/opportunities/{opportunityId}/status

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "fixes": [
    ],
  • "metadata": {
    }
}