diff --git a/docs/index.html b/docs/index.html index 2d0b3984a..9978c3af8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -488,7 +488,7 @@ 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864 -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688, -104.0616 -231.873,-231.248 z - " fill="currentColor">

SpaceCat API (1.103.9)

Download OpenAPI specification:

SpaceCat API (1.103.10)

Download OpenAPI specification:

The SpaceCat API is used to manage edge delivery site directory and obtain audit information.

Authentication

api_key

DEPRECATED, use scoped_api_key or ims_key. (Used for read-only operations.)

@@ -518,7 +518,7 @@ " class="sc-dODueM sc-eHKghg fhLETC jlTrDX">

Development server

https://spacecat.experiencecloud.live/api/ci/organizations/{organizationId}/sites

Production server

-
https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/sites

Response samples

Content type
application/json
[
  • {
    }
]

Create a new site

https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/sites

Response samples

Content type
application/json
[
  • {
    }
]

Create a new site

This endpoint is useful for creating a new site.

Authorizations:
admin_key
Request Body schema: application/json
required
name
string

The name of the site

@@ -540,7 +540,7 @@ " class="sc-dODueM sc-eHKghg fhLETC jlTrDX">

Development server

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

Production server

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

Request samples

Content type
application/json
{
  • "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "deliveryType": "aem_cs",
  • "name": "New Site"
}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
  • "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Site",
  • "deliveryType": "aem_edge",
  • "deliveryConfig": {},
  • "goLiveDate": "2024-01-20T10:00:00Z",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Retrieve all sites

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

Request samples

Content type
application/json
{
  • "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "deliveryType": "aem_cs",
  • "name": "New Site"
}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
  • "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Site",
  • "deliveryType": "aem_edge",
  • "deliveryConfig": {},
  • "goLiveDate": "2024-01-20T10:00:00Z",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Retrieve all sites

This endpoint is useful for retrieving all sites.

Authorizations:
api_key

Responses

Production server

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

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all sites by delivery type

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

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all sites by delivery type

This endpoint is useful for retrieving all sites by delivery type.

Authorizations:
api_key
path Parameters
deliveryType
required
string (DeliveryType)
Enum: "aem_edge" "aem_cs" "other"
Example: aem_edge

The type of the delivery this site is using

@@ -568,7 +568,7 @@ " class="sc-dODueM sc-eHKghg fhLETC jlTrDX">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/by-delivery-type/{deliveryType}

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/by-delivery-type/{deliveryType}

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single site by its Base URL

https://spacecat.experiencecloud.live/api/v1/sites/by-delivery-type/{deliveryType}

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single site by its Base URL

This endpoint is useful for retrieving a site when you only have its Base URL. The Base URL is a unique identifier for a site other than the Site ID. The base URL provided in the path must be base64 encoded. This is to allow for URLs with special characters to be used as path parameters.

@@ -588,7 +588,7 @@ " class="sc-dODueM sc-eHKghg fhLETC jlTrDX">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/by-base-url/{base64BaseUrl}

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/by-base-url/{base64BaseUrl}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
  • "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Site",
  • "deliveryType": "aem_edge",
  • "deliveryConfig": {},
  • "goLiveDate": "2024-01-20T10:00:00Z",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Retrieve all sites including their latest audit

https://spacecat.experiencecloud.live/api/v1/sites/by-base-url/{base64BaseUrl}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
  • "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Site",
  • "deliveryType": "aem_edge",
  • "deliveryConfig": {},
  • "goLiveDate": "2024-01-20T10:00:00Z",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Retrieve all sites including their latest audit

This endpoint is useful for retrieving all sites including their latest audit. @@ -646,7 +646,7 @@ " class="sc-dODueM sc-eHKghg fhLETC jlTrDX">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
  • "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Site",
  • "deliveryType": "aem_edge",
  • "deliveryConfig": {},
  • "goLiveDate": "2024-01-20T10:00:00Z",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Update a site

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

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
  • "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Site",
  • "deliveryType": "aem_edge",
  • "deliveryConfig": {},
  • "goLiveDate": "2024-01-20T10:00:00Z",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Update a site

This endpoint is useful for updating a site. @@ -678,7 +678,7 @@ " class="sc-dODueM sc-eHKghg fhLETC jlTrDX">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}

Request samples

Content type
application/json
{
  • "organizationId": "u7y6t5r4-e3w2-x1z0-z9y8-x7v6w5u4t3s2",
  • "deliveryType": "other",
  • "name": "New Site",
  • "deliveryConfig": {},
  • "goLiveDate": "2024-01-20T10:00:00Z"
}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
  • "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Site",
  • "deliveryType": "aem_edge",
  • "deliveryConfig": {},
  • "goLiveDate": "2024-01-20T10:00:00Z",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Delete a site

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

Request samples

Content type
application/json
{
  • "organizationId": "u7y6t5r4-e3w2-x1z0-z9y8-x7v6w5u4t3s2",
  • "deliveryType": "other",
  • "name": "New Site",
  • "deliveryConfig": {},
  • "goLiveDate": "2024-01-20T10:00:00Z"
}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
  • "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Site",
  • "deliveryType": "aem_edge",
  • "deliveryConfig": {},
  • "goLiveDate": "2024-01-20T10:00:00Z",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Delete a site

This endpoint is useful for deleting a site.

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

The site ID in uuid format

@@ -1148,7 +1148,7 @@ " class="sc-dODueM sc-eHKghg fhLETC jlTrDX">

Development server

https://spacecat.experiencecloud.live/api/ci/organizations

Production server

-
https://spacecat.experiencecloud.live/api/v1/organizations

Request samples

Content type
application/json
{
  • "name": "Example Organization",
  • "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Organization",
  • "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Retrieve all organizations

https://spacecat.experiencecloud.live/api/v1/organizations

Request samples

Content type
application/json
{
  • "name": "Example Organization",
  • "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Organization",
  • "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Retrieve all organizations

This endpoint is useful for retrieving all organizations.

Authorizations:
api_key

Responses

Production server

-
https://spacecat.experiencecloud.live/api/v1/organizations

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single organization by its ID

https://spacecat.experiencecloud.live/api/v1/organizations

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single organization by its ID

This endpoint is useful for retrieving an organization by its ID.

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

The organization ID in uuid format

@@ -1178,7 +1178,7 @@ " class="sc-dODueM sc-eHKghg fhLETC jlTrDX">

Development server

https://spacecat.experiencecloud.live/api/ci/organizations/{organizationId}

Production server

-
https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}

Response samples

Content type
application/json
{
  • "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Organization",
  • "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Update an organization

https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}

Response samples

Content type
application/json
{
  • "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Organization",
  • "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Update an organization

This endpoint is useful for updating an organization. @@ -1206,7 +1206,7 @@ " class="sc-dODueM sc-eHKghg fhLETC jlTrDX">

Development server

https://spacecat.experiencecloud.live/api/ci/organizations/{organizationId}

Production server

-
https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}

Request samples

Content type
application/json
{
  • "name": "Example Organization",
  • "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Organization",
  • "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Delete an organization

https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}

Request samples

Content type
application/json
{
  • "name": "Example Organization",
  • "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Organization",
  • "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Delete an organization

This endpoint is useful for deleting an organization.

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

The organization ID in uuid format

@@ -1258,7 +1258,7 @@ " class="sc-dODueM sc-eHKghg fhLETC jlTrDX">

Development server

https://spacecat.experiencecloud.live/api/ci/organizations/{organizationId}/sites

Production server

-
https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/sites

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve an organization by IMS Org ID

https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/sites

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve an organization by IMS Org ID

This endpoint is useful for retrieving an organization by IMS Org ID.

Authorizations:
api_key
path Parameters
imsOrgId
required
string (ImsOrganizationId)
Example: 1234567890ABCDEF12345678@AdobeOrg

An IMS organization ID

@@ -1276,7 +1276,7 @@ " class="sc-dODueM sc-eHKghg fhLETC jlTrDX">

Development server

https://spacecat.experiencecloud.live/api/ci/organizations/by-ims-org-id/{imsOrgId}

Production server

-
https://spacecat.experiencecloud.live/api/v1/organizations/by-ims-org-id/{imsOrgId}

Response samples

Content type
application/json
{
  • "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Organization",
  • "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Retrieve Slack config for an organization by IMS Org ID

https://spacecat.experiencecloud.live/api/v1/organizations/by-ims-org-id/{imsOrgId}

Response samples

Content type
application/json
{
  • "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
  • "name": "Example Organization",
  • "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
  • "config": {
    },
  • "createdAt": "2023-12-15T09:30:00Z",
  • "updatedAt": "2024-01-19T11:20:00Z"
}

Retrieve Slack config for an organization by IMS Org ID

This endpoint is useful for retrieving the Slack config of an organization by IMS Org ID.

@@ -2446,7 +2446,7 @@ " class="sc-dODueM sc-eHKghg fhLETC jlTrDX">

Production server

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/experiments

Response samples

Content type
application/json
[
  • {
    }
]