Experience Domain Actions

https://api.losant.com/applications/APPLICATION_ID/experience/domains/EXPERIENCE_DOMAIN_ID

Below are the various requests that can be performed against the Experience Domain resource, as well as the expected parameters and the potential responses.

Delete

Deletes an experience domain

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/experience/domains/EXPERIENCE_DOMAIN_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceDomain.*, or experienceDomain.delete.

Request Path Components

Request Headers

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.losant.com/applications/APPLICATION_ID/experience/domains/EXPERIENCE_DOMAIN_ID

Successful Responses

Error Responses

Get

Retrieves information on an experience domain

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/experience/domains/EXPERIENCE_DOMAIN_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceDomain.*, or experienceDomain.get.

Request Path Components

Request Headers

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/experience/domains/EXPERIENCE_DOMAIN_ID

Successful Responses

Error Responses

Patch

Updates information about an experience domain

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/experience/domains/EXPERIENCE_DOMAIN_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceDomain.*, or experienceDomain.patch.

Request Path Components

Request Headers

Request Body

The body of the request should be serialized JSON that validates against the Experience Domain Patch schema. For example, the following would be a valid body for this request:

{
  "domainName": "my.domain.example.com",
  "sslCert": "-----BEGIN CERTIFICATE-----\nMY_SSL_CERTIFICATE\n-----END CERTIFICATE-----",
  "sslKey": "-----BEGIN PRIVATE KEY-----\nMY_SSL_KEY\n-----END PRIVATE KEY-----",
  "version": "develop"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"domainName":"my.domain.example.com","sslCert":"-----BEGIN CERTIFICATE-----\nMY_SSL_CERTIFICATE\n-----END CERTIFICATE-----","sslKey":"-----BEGIN PRIVATE KEY-----\nMY_SSL_KEY\n-----END PRIVATE KEY-----","version":"develop"}' \
    https://api.losant.com/applications/APPLICATION_ID/experience/domains/EXPERIENCE_DOMAIN_ID

Successful Responses

Error Responses