Sign in
applications

Describe an application

Retrieve an application resource.

get/applications/{id}

Path parameters

idstring required

Application id.

Response

The application was successfully retrieved.

hrefstring required

The endpoint for the resource.

idstring required

The id of the resource.

endpointstring

The DNS endpoint for the application.

cdn_statestring

The current state of the CDN assigned to the application. This field can be null.

createdstring required

An iso8601 formatted timestamp

current_outageboolean required

Indicates if the application is currently experiencing an outage.

last_outagestring

An iso8601 formatted timestamp

stage'initial' | 'configured'

The stage that the application is in.

state'running' | 'maintenance' | 'entering_maintenance' | 'exiting_maintenance' | 'starting' | 'stopped' | 'stopping' required

The current state of the application.

namestring

The name of the application.

aliasesstring[]

Ordered array of application domain names. The first array entry will be used as the primary application domain name.

cdn_aliasesstring[]

Array of application domain names published to CDN.

cdn_readyboolean

True when a delivery = cdn has been configured and is ready.

cdn_servicestring

A href to the cdn service configured for the application.

default_hostnamestring

Alias for an application

dns_servicestring nullable

A href to the dns service configured for the application.

delivery'cdn' | 'rewrite-to-cdn' | 'without-cdn'

The mode of delivery for an application. One of 'cdn', 'without-cdn', or 'rewrite-to-cdn'. The 'rewrite-to-cdn' mode is not recommended for new applications

enable_cdnboolean

Enable CDN for the application. This is not used if the 'delivery' attribute is set

enable_http2boolean

Enable HTTP2 for the application.

enable_rumboolean

Enable RUM for the application.

enable_tlsboolean

Enable TLS for the application. The tls_configuration is required if true.

monitoring'none' | 'passive' | 'active'

The monitoring mode. When active, the application will be monitored regularly from a separate location, in addition to passive monitoring. When passive, the error rate for the application is monitored and used to generate alerts, but if there is no regular activity to the application, then no outage will be detected.

whitelist_hrefstring

The endpoint for an address set resource

blacklist_hrefstring

The endpoint for an address set resource

blacklist_user_agentsstring nullable

A regular expression of user agents to be restricted access.

concurrent_limitinteger

Maximum number of concurrently active requests that can be run in a load balancer before requests are put in the suspend queue. This attribute may only be set by system administrators

maximum_queue_timeinteger

Maximum amount of time a request can spend in the suspend queue of a load balancer before it is failed with a timeout. This attribute may only be set by system administrators

merge_slashesboolean

Controls whether the server merges consecutive slashes in URLs. By default, consecutive slashes are merged into a single slash.

suspend_limitinteger

Maximum number of requests that can be put in the suspend queue of a load balancer before the oldest requests are failed. This attribute may only be set by system administrators

probesstring[]
protection'normal' | 'maximum'

The protection mode.

protection_captcha_retry_limitinteger

Number of incorrect attempts a user is allowed before the user may be blacklisted.

protection_blacklist_timeoutinteger

Number of seconds to enforce blacklist on the suspicious user.

protection_microsite_filestring

Endpoint for the file id associated with the captcha microsite.

clusterstring nullable

The endpoint for the cluster resource.

request_timeoutinteger

Time for which Webscale proxy will wait for a backend server to respond. If proxy does not receive response in a specified time from the backend server, a maintenance page with status 502 Bad Gateway will be returned

shields_include_whitelistboolean

Add whitelist addresses to shields. By default whitelist addresses are not added to the shields. Google cloud supports only IPv4 addresses in their firewall rules. Any IPv6 addresses in the whitelist will not be added to the firewall rules for Google. AWS supports both IPv4 and IPv6 addresses in the security groups

data_planesstring[]

Configured data planes

trusted_proxies_onlyboolean

Allows external traffic only from addresses from the configured trusted proxies, the control addresses, and pingdom.

trusted_proxies_headerstring

The name of the header from a trusted proxy that is used to obtain the request address. When not set, X-Forwarded-For is used.

labelsLabel[]

Array of labels that will be attached to the application.

translate_path'preserve' | 'unescape'

Configuration to specify the handling of URL paths through the Webscale proxy. The default behavior is to leave the path value untouched (preserve). A value of 'unescape' would remove all escaped characters in the path and replace them with their equivalent unicode character.

pagespeed_disallowstring[]

A set of URL patterns to exclude from pagespeed optimization

pagespeed_exclude_agentsstring

User agents that match this regular expression are excluded from pagespeed

pagespeed_map_proxy_domainsstring[]

A set of domains that are integrated into the pages for this site

micrositestring

Endpoint resource reference to a file.

Changes