Returns a specific deploy request.
Retrieve a deploy request via the following request:
HTTP Method | Request URI |
---|---|
GET |
https://api.vdms.io/rules-engine/v1.1/deploy-requests/DeployRequestID |
Define the following variable when submitting the above request:
VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3). | Description |
---|---|
Required |
Replace this variable with the system-defined ID for the desired deploy request. Retrieve deploy requests and their system-defined IDs via the Get Deploy Requests endpoint. |
This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.
Unlike requests to api.edgecast.com, requests to our API gateway (api.vdms.io) require an access token (OAuth).
Request body parameters are not required by this endpoint.
The response to the above request includes an HTTP status code, response headers, and a response body.
A status code indicates whether the request was successfully performed.
The response for this endpoint only includes standard HTTP response headers.
The response body for a successful request contains the following response elements:
Name | Data Type | Description |
---|---|---|
@id |
String |
Indicates the relative path to an endpoint through which you may retrieve the current deploy request. |
@type |
String |
Returns DeployRequest. |
id |
String |
Identifies the deploy request by its system-defined ID. |
customer_id |
String |
Indicates your customer account number. |
state |
String |
Indicates the deploy request's state. Valid values are: submitted | approved | rejected | deployed | pending_review | escalated | canceled | verification_delayed | deployment_delayed
|
environment |
String |
Indicates the environment to which the deploy request was applied. Valid values are: production | staging
|
created_at |
String |
Indicates the date and time (UTC) at which the deploy request was submitted. Syntax: YYYY-MM-DDThh:mm:ssZ
Example: 2024-01-08T20:31:06Z
|
updated_at |
String |
Indicates the date and time (UTC) at which the deploy request's state was last updated. Syntax: YYYY-MM-DDThh:mm:ssZ
|
is_visible |
Boolean |
Indicates whether the deploy request is visible within the MCC. Valid values are: true | false
|
Object |
Contains the policy associated with the deploy request. |
|
Array |
Describes each state change for this deploy request. |
|
Object |
Describes the user that retrieved the deploy request. |
The policies object describes a policy using the following parameters:
Name | Data Type | Description |
---|---|---|
@id |
String |
Indicates the relative path to an endpoint through which you may retrieve the current policy. |
@type |
String |
Returns Policy. |
id |
String |
Identifies the policy by its system-defined ID. |
name |
String |
Identifies the policy by its name. |
description |
String |
Indicates the policy's description. |
policy_type |
String |
Returns customer. |
state |
String |
Indicates the policy's state. Valid values are:
|
platform |
String |
Indicates the delivery platform corresponding to the policy. Valid values are:
|
created_at |
String |
Indicates the date and time (UTC) at which the policy was created. Syntax: YYYY-MM-DDThh:mm:ssZ
Example: 2024-01-08T20:31:06Z
|
updated_at |
String |
Indicates the date and time (UTC) at which the policy was last updated. Syntax: YYYY-MM-DDThh:mm:ssZ
|
rules |
Array |
Contains the rules associated with this policy. Each object in this array contains a rule. |
@id |
String |
rules array Indicates the relative path to an endpoint through which you may retrieve the current rule. This endpoint has not been released yet. |
@type |
String |
rules array Returns Rule. |
id |
String |
rules array Identifies the rule by its system-defined ID. |
name |
String |
rules array This parameter is reserved for future use. |
description |
String |
rules array Indicates the rule's description. |
ordinal |
Integer |
rules array Indicates the position of the rule within the policy. |
created_at |
String |
rules array Indicates the date and time (UTC) at which the rule was created. Syntax: YYYY-MM-DDThh:mm:ssZ
Example: 2024-01-08T20:31:06Z
|
updated_at |
String |
rules array Indicates the date and time (UTC) at which the rule was last updated. Syntax: YYYY-MM-DDThh:mm:ssZ
|
Array |
rules array Contains the match conditions associated with the rule. Each object in this array contains a match condition configuration. Match conditions are listed in the order in which they appear in the rule. |
The matches array describes one or more match condition(s) using the following parameters:
The set of supported parameters varies by match condition.
Name | Data Type | Description |
---|---|---|
compare |
String |
Device - Resolution Height and Resolution Width Only Determines how the value defined in the value parameter will be compared against the request. Set this parameter to the desired mathematical operator. Valid values are: == | < | <= | > | >=
|
Array |
Contains the features associated with this match condition. Each object in this array contains a feature configuration. |
|
hostnames |
String |
match.request.edge-cname.literal Match Condition Only Identifies a hostname corresponding to an edge CNAME configuration. |
ignore_case |
Boolean |
Determines whether the comparison between the value parameter and the request will be case-sensitive. Valid values are:
Certain match conditions use a parameter other than value to determine whether a request is a match. The ignore_case parameter applies to whichever parameter will be compared against the request. For example, match.request.edge-cname.literal uses hostnames. |
Array |
Contains the match conditions associated with this match condition. Each object in this array contains a match condition configuration. Match conditions are listed in the order in which they appear in the rule. |
|
name |
String |
Identifies the entity that will be matched. Example: The match.request.cookie.literal match condition uses this parameter to identify the cookie whose value will be compared against the value parameter. |
ordinal |
Integer |
Indicates the position of the match condition within the rule. |
relative_to |
String |
URL Match Conditions Only Determines where the URL comparison will start. Valid values are: root | origin
|
result |
String |
Determines whether the comparison must result in a match in order to satisfy this match condition. Valid values are: match | nomatch
|
type |
String |
Identifies a match condition by its code name. View valid values.
Mutually Exclusive (Select First Match) Use select.first-match to create mutually exclusive match conditions (i.e., Select First Match). Nest the desired mutually exclusive match conditions within a child matches array. ... "matches": [{ "type": "select.first-match", "ordinal": 1, "matches": [{ "type": "match.url.url-path.wildcard", ... Independent Match Conditions Use one of the following values:
|
value |
String | Array of string values |
Determines the value that will be compared against the request. Acceptable values for this parameter vary by match condition. Multiple values (e.g., space-separated values) are returned as an array |
The features array describes one or more feature(s) associated with the parent match condition using the following parameters:
View the set of supported parameters for each feature in the features array template provided below this table.
Name | Data Type | Description |
---|---|---|
action |
String |
Indicates the action (e.g., set) that will take place. |
code |
String |
Indicates a HTTP status code. |
codes |
String | Array of string values |
Indicates one or more HTTP status codes. Multiple values (e.g., space-separated values) are returned as an array |
destination |
String |
Identifies a relative path via a regular expression. |
enabled |
Boolean |
Determines whether the feature will be enabled. Valid values are: true | false
|
extensions |
String | Array of string values |
Identifies one or more file extensions. Multiple values (e.g., space-separated values) are returned as an array |
format |
String |
feature.logs.custom-log-field-1 Feature Only Indicates the format and the content that will be assigned to a custom log field. |
header_name |
String |
feature.access.token-auth-denial-code Feature Only Set this to Location. |
header_value |
String |
feature.access.token-auth-denial-code Feature Only Identifies the URL to which unauthorized requests will be redirected. |
instance |
String |
feature.waf.web-application-firewall Feature Only Identifies a WAF instance by its system-defined ID. |
kbytes_per_second |
Integer |
feature.caching.bandwidth-throttling Feature Only Indicates the bandwidth, in Kbps, to which requests will be throttled. |
media_types |
String |
feature.caching.compress-file-types Feature Only Specify one or more media types (aka content types). |
methods |
String | Array of string values |
feature.specialty.cacheable-http-methods Feature Only Specify one or more supported HTTP methods. Multiple values (e.g., space-separated values) are returned as an array |
mode |
String |
feature.caching.cache-key-query-string Feature Only Determine whether query string parameters will be included in the cache-key. Valid values are: include | exclude | include-all | exclude-all
|
name |
String |
Identifies the object (e.g., request header) on which the feature will be applied by its name. |
names |
String |
feature.origin.proxy-special-headers Feature Only Identifies one or more CDN-specific request header that will be forwarded to an origin server. Multiple values (e.g., space-separated values) are returned as an array |
ordinal |
Integer |
Indicates the position of the feature. |
parameters |
String |
feature.caching.cache-key-query-string Feature Only Identifies one or more query string parameters by their names. |
prebuf_seconds |
Integer |
feature.caching.bandwidth-throttling Feature Only Determines the number of seconds that our edge servers will wait until throttling bandwidth. |
requests |
Integer |
feature.origin.max-keep-alive-requests Feature Only Determines the maximum number of requests for a Keep-Alive connection before it is closed. |
seek_end |
String |
feature.caching.h264-support-video-seek-params Feature Only Overrides the name assigned to ec_end. |
seek_start |
String |
feature.caching.h264-support-video-seek-params Feature Only Overrides the name assigned to ec_seek. |
source |
String |
Identifies a relative path via a regular expression. |
status |
String |
Identifies requests via a HTTP status code. |
treatment |
String |
Determines how an edge server will handle a header. |
type |
String |
Identifies a feature by its code name. View valid values.
Valid values are:
View the set of supported parameters for each feature in the features array template provided below this table. |
units |
String |
Determines the time unit that will be used for the value parameter. |
value |
String | Integer | Array |
Determines the value that will be set. Multiple values (e.g., space-separated values) are returned as an array. |
Use the following code excerpt to view a list of features and the set of information returned for each feature.
"features": [{ "type": "feature.caching.complete-cache-fill", "ordinal": 0, "enabled": true }, { "type": "feature.caching.compress-file-types", "ordinal": 0, "media_types": "string" }, { "type": "feature.caching.default-internal-max-age", "ordinal": 0, "status": "200", "value": 0, "units": "off" }, { "type": "feature.caching.external-max-age", "ordinal": 0, "value": 0, "units": "off" }, { "type": "feature.caching.force-internal-max-age", "ordinal": 0, "status": "200", "value": 0, "units": "off" }, { "type": "feature.access.deny-access", "ordinal": 0, "enabled": true }, { "type": "feature.access.token-auth", "ordinal": 0, "enabled": true }, { "type": "feature.access.token-auth-denial-code", "ordinal": 0, "code": "301", "header_name": "", "header_value": "string" }, { "type": "feature.caching.bypass-cache", "ordinal": 0, "enabled": true }, { "type": "feature.caching.cache-control-header-treatment", "ordinal": 0, "treatment": "pass" }, { "type": "feature.caching.cache-key-query-string", "ordinal": 0, "mode": "include", "parameters": "string" }, { "type": "feature.caching.expires-header-treatment", "ordinal": 0, "treatment": "pass" }, { "type": "feature.access.token-auth-ignore-url-case", "ordinal": 0, "enabled": true }, { "type": "feature.access.token-auth-parameter", "ordinal": 0, "name": "string", "enabled": true }, { "type": "feature.caching.bandwidth-parameters", "ordinal": 0, "enabled": true }, { "type": "feature.caching.bandwidth-throttling", "ordinal": 0, "prebuf_seconds": 0, "kbytes_per_second": 0 }, { "type": "feature.caching.cache-key-rewrite", "ordinal": 0, "source": "string", "destination": "string" }, { "type": "feature.caching.h264-support", "ordinal": 0, "extensions": "string" }, { "type": "feature.caching.honor-no-cache-request", "ordinal": 0, "enabled": true }, { "type": "feature.caching.ignore-origin-no-cache", "ordinal": 0, "codes": "string" }, { "type": "feature.caching.ignore-unsatisfiable-ranges", "ordinal": 0, "enabled": true }, { "type": "feature.caching.internal-max-stale", "ordinal": 0, "status": "200", "value": 0, "units": "off" }, { "type": "feature.caching.partial-cache-sharing", "ordinal": 0, "enabled": true }, { "type": "feature.caching.prevalidate-cached-content", "ordinal": 0, "value": 0, "units": "off" }, { "type": "feature.caching.refresh-zero-byte-cache-files", "ordinal": 0, "enabled": true }, { "type": "feature.caching.set-cacheable-status-codes", "ordinal": 0, "codes": "string" }, { "type": "feature.caching.stale-content-delivery-on-error", "ordinal": 0, "enabled": true }, { "type": "feature.caching.stale-while-revalidate", "ordinal": 0, "value": 0, "units": "off" }, { "type": "feature.comment", "ordinal": 0, "value": "string" }, { "type": "feature.headers.age-response-header", "ordinal": 0, "enabled": true }, { "type": "feature.headers.debug-cache-response-headers", "ordinal": 0, "enabled": true }, { "type": "feature.headers.modify-client-request-header", "ordinal": 0, "action": "set", "name": "string", "value": "string" }, { "type": "feature.logs.custom-log-field-1", "ordinal": 0, "format": "string" }, { "type": "feature.logs.log-query-string", "ordinal": 0, "enabled": true }, { "type": "feature.optimizer.edge-optimizer", "ordinal": 0, "enabled": true }, { "type": "feature.optimizer.edge-optimizer-instantiate-configuration", "ordinal": 0, "site": "string" }, { "type": "feature.origin.max-keep-alive-requests", "ordinal": 0, "requests": 0 }, { "type": "feature.origin.proxy-special-headers", "ordinal": 0, "names": "string" }, { "type": "feature.specialty.cacheable-http-methods", "ordinal": 0, "methods": "GET" }, { "type": "feature.headers.modify-client-response-header", "ordinal": 0, "action": "set", "name": "string", "value": "string" }, { "type": "feature.headers.set-client-ip-custom-header", "ordinal": 0, "enabled": true, "name": "string" }, { "type": "feature.specialty.cacheable-request-body-size", "ordinal": 0, "value": 0, "units": "bytes" }, { "type": "feature.specialty.user-variable", "ordinal": 0, "name": "string", "value": "string" }, { "type": "feature.url.follow-redirects", "ordinal": 0, "enabled": true }, { "type": "feature.url.url-redirect", "ordinal": 0, "source": "string", "destination": "string", "code": "301" }, { "type": "feature.url.url-rewrite", "ordinal": 0, "source": "string", "destination": "string" }, { "type": "feature.waf.web-application-firewall", "ordinal": 0, "instance": "string" }, { "type": "feature.caching.h264-support-video-seek-params", "ordinal": 0, "seek_start": "string", "seek_end": "string" } ]
The history object describes the deploy request's state changes using the following parameters:
Name | Data Type | Description |
---|---|---|
id | String | Identifies this entry by its system-defined ID. |
state | String |
Indicates the deploy request's new state. Valid values are: submitted | approved | rejected | deployed | pending_review | escalated | canceled | verification_delayed | deployment_delayed
|
created_at | String |
Indicates the date and time (UTC) at which the deploy request entered the state identified by the state property. Syntax: YYYY-MM-DDThh:mm:ssZ
Example: 2024-01-08T20:31:06Z
|
Object |
Describes the user that requested the change in state. User information is not provided when the deploy request's change in state is due to an automated review or approval. |
The user object describes a user using the following parameters:
Name | Data Type | Description |
---|---|---|
id | String | Identifies a user by its system-defined ID. |
first_name | String | Indicates a user's first name. |
last_name | String | Indicates a user's last name. |
|
String |
Indicates a user's email address. |
The response body for an unsuccessful request will contain an error response that provides additional information.
A sample JSON request is shown below.
GET https://api.vdms.io/rules-engine/v1.1/deploy-requests/55123 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: api.vdms.io
A sample JSON response is shown below.
HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Type: application/json; charset=utf-8
Date: Thu, 15 Apr 2021 12:00:00 GMT
Content-Length: 4581
{ "@id": "/rules-engine/v1.1//deploy-requests/5516879", "@type": "DeployRequest", "id": "5516879", "customer_id": "0001", "state": "deployed", "environment": "production", "created_at": "2019-08-13T17:23:19Z", "updated_at": "2019-08-13T17:24:14Z", "is_visible": true, "policies": { "@id": "/rules-engine/v1.1/policies/16879", "@type": "Policy", "id": "16879", "name": "My First Policy", "description": null, "policy_type": "customer", "state": "locked", "platform": "http_large", "created_at": "2016-03-22T17:15:47Z", "updated_at": "2016-06-29T23:00:19Z", "rules": [{ "@id": "/rules-engine/v1.1/policies/16879/rules/59712", "@type": "Rule", "id": "59712", "name": "", "description": "", "ordinal": 1, "created_at": "2017-06-08T21:16:39Z", "updated_at": "2017-06-08T21:16:39Z", "matches": [{ "type": "match.always", "ordinal": 1, "features": [{ "type": "feature.caching.external-max-age", "ordinal": 1, "value": "3", "units": "minutes" }, { "type": "feature.caching.force-internal-max-age", "ordinal": 2, "status": "200", "value": "1", "units": "hours" }, { "type": "feature.caching.default-internal-max-age", "ordinal": 3, "status": "200", "value": "1", "units": "hours" }, { "type": "feature.headers.modify-client-response-header", "ordinal": 4, "action": "set", "name": "Strict-Transport-Security", "value": "max-age=63072000" }, { "type": "feature.headers.modify-client-response-header", "ordinal": 5, "action": "set", "name": "X-Content-Type-Options", "value": "nosniff" }, { "type": "feature.headers.modify-client-response-header", "ordinal": 6, "action": "set", "name": "X-Frame-Options", "value": "SAMEORIGIN" }, { "type": "feature.waf.web-application-firewall", "ordinal": 7, "instance": "16879456-e060dd56-290e-4a6e-a275-ffbe63c5412b" } ] } ] } ] }, "history": [{ "id": "61191", "state": "deployed", "created_at": "2019-08-13T17:24:14Z", "user": { "id": "0", "first_name": null, "last_name": null, "email": null } }, { "id": "61190", "state": "approved", "created_at": "2019-08-13T17:23:49Z", "user": { "id": "0", "first_name": null, "last_name": null, "email": null } }, { "id": "61189", "state": "submitted", "created_at": "2019-08-13T17:23:19Z", "user": { "id": "344984", "first_name": "Joe", "last_name": "Smith", "email": "joe.smith@example.com" } } ], "user": { "id": "344984", "first_name": "Joe", "last_name": "Smith", "email": "joe.smith@example.com" } }