List origins

get https://{hostname}/api/content-delivery/v1/content-providers/{contentProviderId}/origins

This operation displays the origins owned by the Content Provider specified by contentProviderId.

Path Params

contentProviderId

integer

required

Unique identifier for each Content Provider.

Query Params

filter

string

Specifies a query to filter down the set of results. The accompanying example specifies more than one query, where ; and , delimiters clarify AND and OR logic. (Optional parentheses clarify logical groupings.) The == and != operators test equivalency. The =lt=, =le=, =gt=, and =ge= operators compare numbers. The =contains= and =excludes= operators match elements within an array.

view

string

Defaults to summary

Results display either summary or detailed objects.

sortBy

string

Specifies an object field name to sort results on. Provide a comma-separated list of field names for additional sort criteria. Prefix field names with a dash for descending sort order. For example, name,-tlsIngestProfileId sorts primarily by name, then IDs in descending order.

pageNumber

integer

≥ 1

Defaults to 1

Specifies an offset within the full set of results, with page numbers starting at 1. Use this in conjunction with pageSize.

pageSize

integer

1 to 1000

Defaults to 100

Specifies the number of results on each page. Use this in conjunction with pageNumber.

Responses

Response body

object

origins

array of objects

required

origins*

object

originId

integer

required

≥ 1

Identifies the Origin object.

originTimeout

integer

1 to 300

Defaults to 300

Origin idle connection timeout in seconds, specifies the length of time the HPC waits for a response to a request from an origin. If no response is received from an origin server within the configured timeout value, four additional attempts are made to the same origin server. If no response is received for the final request within the configured timeout, then that connection is terminated, and a 504 response is sent to the requesting client.

contentProviderId

integer

≥ 1

Identifies the content provider object.

enable

boolean

Defaults to true

Enables the CDN to deliver content from this origin server, true by default.

hostname

string

required

Hostname of the origin server.

tlsIngestProfileId

integer

≥ 1

Identifies the TLS ingest profile object.

storagePartitionId

integer

≥ 1

Identifies the storage partition object.

cachingType

string

Defaults to OPTIMISTIC

Determines whether to validate requests for cached content with the origin server. With default OPTIMISTIC caching, the HyperCache serves cached content without validating the content with the origin server, unless the content is expired. With CONSERVATIVE caching, every cache request is validated with the origin server by sending an HTTP HEAD request. If the content is stale, the HyperCache node gets the new content from the origin server. The old content ages out of the cache.

CONSERVATIVE OPTIMISTIC

enableAuthenticatedContent

boolean

Defaults to false

Causes the HyperCache to send a HEAD request to the origin server for each client request. If the response is a status code of 2XX, the content is served to the client. Otherwise, the origin's status code is returned. This typically occurs when the origin server authenticates the client request using a cookie, token, or other means. Default is false.

enableSiteRedirects

boolean

Defaults to true

Determines whether or not HyperCache redirects a client to a better site based on the rules in the site map. Enabling this to true allows the HyperCache to adhere to the LCDN site map configured using the request router service. If set to false, cache miss client requests to a CDN prefix that uses this origin server as a default result in a HyperCache request for the content directly to the origin server.

enableRequestIdExport

boolean

Defaults to false

Causes the Hypercache to send its internal request ID to the origin server when ingesting content.

cacheKeyOriginHostnameOriginId

integer

≥ 1

Set this only if you are configuring multiple origin servers that have identical content. It maps multiple incoming URLs, each requesting the same content from different origins identified by the hostname field above, to a single origin server identified by this cacheKeyOriginHostnameOriginId field. Doing so enables HyperCaches to conserve cache space and reduces ingest bandwidth.

edgeHostType

string

Defaults to HTTP

Indicates whether the origin server is an AEX (Aura Edge eXchange) server, or HTTP, the default.

HTTP AEX

edgeHostname

string

Hostname of the AEX origin server.

dynamicHierarchy

object

Configure a HyperCache node that is the endpoint of an origin path (a root HyperCache) to monitor the health of the origin server by sending a GET request for a specific URL.

interSiteProtocol

string

Defaults to HTTP

The protocol used to transport this origin's content between Sites in the LCDN, either HTTP or HTTPS.

HTTP HTTPS

intraSiteProtocol

string

Defaults to HTTP

The protocol used to transport this origin's content between nodes within a site in the LCDN, either HTTP or HTTPS.

HTTP HTTPS

fastReroute

object

Enables a HyperCache node to detect failed or slow connections to a specific origin IP address, or between Sites, and to send a second request to an alternate origin IP (or site) if the first request is delayed. If a successful response is received from either origin IP (or site), the first response is used to fulfill a client's request. The second response, if received, is ignored. If no connection to either destination is established, or if no response is received within the configured origin timeout value, the requests to the origin (or site) are retried four times before a 504 is returned to the client. This method helps ensure rapid recovery in case a temporary network problem results in loss of the initial request or response.

resolvableHostnames

array of strings

length ≤ 50

A list of virtual hosts, origin servers with resolvable hostnames. These resolvable hostnames are used by DNS to determine the IP addresses of the destination origin server.

resolvableHostnames

errorCacheMaxAge

integer

0 to 60

The maximum amount of time the HTTP status codes is cached by the HPC.

errorCacheMaxRetry

integer

0 to 16

The maximum number of retries in the case of an error response.

cacheableErrorResponseCodes

array of strings

length ≤ 256

A list of HTTP status codes that the HPC caches. Each item is either a single code or a range of codes. The following codes are not allowed, either in single code or as part of a range: 200, 203, 206, 300, 301, 410, 416.

cacheableErrorResponseCodes

page

object

required

Common page properties for search results.

pageNumber

integer

required

Indicates the page number of the current results, given the page size.

pageSize

integer

required

Indicates the page size for the current results.

totalPages

integer

Indicates the total number of pages, taking the pages size into consideration.

totalResults

integer

Indicates the total number of results from the search.

200Successful response

403An HTTP 403 will be returned if the principal is not authorized to access the instance of blocklist that the request was made against.