Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extole Domains API

The Domains API from Extole — 10 operation(s) for domains.

Extole Domains API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Domains. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 16 operations across 10 paths, and defines 18 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://{brand}.extole.io.

16 operations 10 paths 18 schemas 2 DELETE7 GET5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole Domains API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as extole_token (COOKIE). An API key is passed in the header as Authorization (HEADER). An API key is passed in the query as access_token (QUERY). By default, every request must be authenticated.

Paths & Operations 16

Across 10 paths, the API surfaces 16 operations — 2 DELETE, 7 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Domains 16
GET
/v1/client-domain-patterns
List client domain patterns
listClientDomainPatterns 4 params → 200400401402403415429
POST
/v1/client-domain-patterns
Create client domain pattern
createClientDomainPattern body → 200400401402403415429
GET
/v1/client-domain-patterns/built
List built client domain patterns
listBuiltClientDomainPatterns 4 params → 200400401402403415429
GET
/v1/client-domain-patterns/{id}
Get client domain pattern
getClientDomainPattern 1 param → 200400401402403415429
PUT
/v1/client-domain-patterns/{id}
Update client domain pattern
updateClientDomainPattern 1 param body → 200400401402403415429
DELETE
/v1/client-domain-patterns/{id}
Archive client domain pattern
archiveClientDomainPattern 1 param → 200400401402403415429
GET
/v1/client-domain-patterns/{id}/built
Get built client domain pattern
getBuiltClientDomainPattern 1 param → 200400401402403415429
POST
/v1/client-domain-patterns/{id}/delete
Delete client domain pattern
deleteClientDomainPattern 1 param → 200400401402403415429
POST
/v1/client-domain-patterns/{id}/unarchive
Unarchive client domain pattern
unarchiveClientDomainPattern 1 param → 200400401402403415429
GET
/v1/client-domains
List client domains
listClientDomains 1 param → 200400401402403415429
POST
/v1/client-domains
Create client domain
createClientDomain body → 200400401402403415429
GET
/v1/client-domains/{client_domain_id}
Get client domain
getClientDomain 1 param → 200400401402403415429
PUT
/v1/client-domains/{client_domain_id}
Update client domain
updateClientDomain 1 param body → 200400401402403415429
DELETE
/v1/client-domains/{client_domain_id}
Archive client domain
archive 2 params → 200400401402403415429
GET
/v1/client-domains/{client_domain_id}/decrypt
Get client domain with decrypted SSL private key
getDecrypt 1 param → 200400401402403415429
POST
/v1/client-domains/{client_domain_id}/validate
Validate client domain
validate 1 param → 200400401402403415429

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ClientDomainResponse (14 properties), ClientDomainCreateRequest (10 properties), ClientDomainUpdateRequest (8 properties), ClientDomainPatternResponse (7 properties). Each schema is shown below with its type and property counts.

ClientDomainPatternCreateRequest
object
Body of a POST /v1/client-domain-patterns request.
6 properties 1 required
TestInClientDomainPatternResponse
Build-time expression that marks whether the pattern is used for test traffic only.
ClientDomainCreateRequest
object
Body of a POST /v1/client-domains request.
10 properties 10 required
PatternInClientDomainPatternResponse
Build-time expression that resolves to the domain pattern used for matching.
ClientDomainPatternResponse
object
Client domain pattern source definition with build-time expressions and component references.
7 properties 7 required
ClientDomainPatternUpdateRequest
object
Body of a PUT /v1/client-domain-patterns/{id} request.
6 properties
ClientDomainResponse
object
14 properties 14 required
ClientDomainGlobPatternResponse
object
3 properties
BuiltClientDomainPatternResponse
object
Built client domain pattern with evaluated runtime values used for domain matching.
7 properties 7 required
PatternInClientDomainPatternCreateRequest
Choose between static or dynamic pattern
TestInClientDomainPatternUpdateRequest
Choose between static or dynamic test
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
ComponentReferenceResponse
object
2 properties
PatternInClientDomainPatternUpdateRequest
Choose between static or dynamic pattern
ComponentReferenceRequest
object
2 properties
ClientDomainDomainValidationResponse
object
3 properties 3 required
ClientDomainUpdateRequest
object
Body of a PUT /v1/client-domains/{clientdomainid} request.
8 properties
TestInClientDomainPatternCreateRequest
Choose between static or dynamic test

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-domains-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API