Experience Domains Actions

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

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

Get

Returns the experience domains for an application

Method And Url

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

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, experienceDomains.*, or experienceDomains.get.

Request Path Components

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

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

Successful Responses

Code Type Description
200 Experience Domains Collection of experience domains

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found

Post

Create a new experience domain for an application

Method And Url

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

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, experienceDomains.*, or experienceDomains.post.

Request Path Components

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Request Body

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

{
  "domainName": "my.example.domain.com",
  "sslCert": "MY_SSL_CERTIFICATE",
  "sslKey": "MY_SSL_KEY",
  "version": "develop"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"domainName":"my.example.domain.com","sslCert":"MY_SSL_CERTIFICATE","sslKey":"MY_SSL_KEY","version":"develop"}' \
    https://api.losant.com/applications/APPLICATION_ID/experience/domains

Successful Responses

Code Type Description
201 Experience Domain Successfully created experience domain

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found