Cancel Deploy Request

Cancels a deploy request.

Request

A request to cancel a deploy request is described below.

HTTP Method	Request URI
PATCH	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
DeployRequestID 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.

Description

DeployRequestID

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.

Request Headers

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

The request parameters for this endpoint are described below.

Name	Data Type	Description
state Required	String	Set it to canceled.
message Required	String	Indicate why the policy is being canceled.

Name

Data Type

Description

state

Required

String

Set it to canceled.

message

Required

String

Indicate why the policy is being canceled.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

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 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: draft: Policies in this state may be modified. locked: Most of a locked policy's properties are read-only.
platform	String	Indicates the delivery platform corresponding to the policy. Valid values are: http_large http_small adn
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
matches	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.
history	Array	Describes each state change for this policy.

matches Array

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: == \| < \| <= \| > \| >=
features	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: True: A match will be found regardless of case. False: A case-sensitive comparison will be performed. 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.
matches	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 Learn more.
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: match.always match.device.brand-name.literal match.device.brand-name.regex match.device.brand-name.wildcard match.device.device-os.literal match.device.device-os.regex match.device.device-os.wildcard match.device.device-os-version.literal match.device.device-os-version.regex match.device.device-os-version.wildcard match.device.dual-orientation.boolean match.device.html-preferred-dtd.literal match.device.html-preferred-dtd.regex match.device.html-preferred-dtd.wildcard match.device.image-inlining.boolean match.device.is-android.boolean match.device.is-app.boolean match.device.is-full-desktop.boolean match.device.is-ios.boolean match.device.is-robot.boolean match.device.is-smartphone.boolean match.device.is-smarttv.boolean match.device.is-tablet.boolean match.device.is-touchscreen.boolean match.device.is-windows-phone.boolean match.device.is-wireless-device.boolean match.device.marketing-name.literal match.device.marketing-name.regex match.device.marketing-name.wildcard match.device.mobile-browser.literal match.device.mobile-browser.regex match.device.mobile-browser.wildcard match.device.mobile-browser-version.literal match.device.mobile-browser-version.regex match.device.mobile-browser-version.wildcard match.device.model-name.literal match.device.model-name.regex match.device.model-name.wildcard match.device.progressive-download.boolean match.device.release-date.literal match.device.release-date.regex match.device.release-date.wildcard match.device.resolution-height.integer match.device.resolution-width.integer match.location.as-number.literal match.location.city-name.literal match.location.city-name.regex match.location.continent.literal match.location.country.literal match.location.dma-code.literal match.location.latitude.literal match.location.longitude.literal match.location.metro-code.literal match.location.postal-code.literal match.location.region-code.literal match.origin.cdn-origin.literal match.origin.customer-origin.literal match.request.client-ip-address.literal match.request.cookie.literal match.request.cookie.regex match.request.cookie.wildcard match.request.edge-cname.literal match.request.referring-domain.literal match.request.referring-domain.wildcard match.request.request-header.literal match.request.request-header.regex match.request.request-header.wildcard match.request.request-method.literal match.request.request-scheme.literal match.url.url-path.literal match.url.url-path.regex match.url.url-path.wildcard match.url.url-path-directory.literal match.url.url-path-directory.wildcard match.url.url-path-extension.literal match.url.url-path-extension.wildcard match.url.url-path-filename.literal match.url.url-path-filename.wildcard match.url.url-query.literal match.url.url-query.regex match.url.url-query.wildcard match.url.url-query-param.literal match.url.url-query-param.wildcard Learn more.
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. Learn more. Multiple values (e.g., space-separated values) are returned as an array of string values.

features 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 of string values.
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 of string values.
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. Learn more.
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 of string values.
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 Learn more.
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 of string values.
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: feature.access.deny-access feature.access.token-auth feature.access.token-auth-denial-code feature.access.token-auth-ignore-url-case feature.access.token-auth-parameter feature.caching.bandwidth-parameters feature.caching.bandwidth-throttling feature.caching.bypass-cache feature.caching.cache-control-header-treatment feature.caching.cache-key-query-string feature.caching.cache-key-rewrite feature.caching.complete-cache-fill feature.caching.compress-file-types feature.caching.default-internal-max-age feature.caching.expires-header-treatment feature.caching.external-max-age feature.caching.force-internal-max-age feature.caching.h264-support feature.caching.h264-support-video-seek-params feature.caching.honor-no-cache-request feature.caching.ignore-origin-no-cache feature.caching.ignore-unsatisfiable-ranges feature.caching.internal-max-stale feature.caching.partial-cache-sharing feature.caching.prevalidate-cached-content feature.caching.refresh-zero-byte-cache-files feature.caching.set-cacheable-status-codes feature.caching.stale-content-delivery-on-error feature.caching.stale-while-revalidate feature.comment feature.headers.age-response-header feature.headers.debug-cache-response-headers feature.headers.modify-client-request-header feature.headers.modify-client-response-header feature.headers.set-client-ip-custom-header feature.logs.custom-log-field-1 feature.logs.log-query-string feature.logs.mask-client-subnet feature.optimizer.edge-optimizer feature.optimizer.edge-optimizer-instantiate-configuration feature.origin.max-keep-alive-requests feature.origin.proxy-special-headers feature.specialty.cacheable-http-methods feature.specialty.cacheable-request-body-size feature.specialty.quic feature.specialty.revalidate-while-stale feature.specialty.revalidate-while-stale-timer feature.specialty.streaming-optimization feature.specialty.user-variable feature.url.follow-redirects feature.url.url-redirect feature.url.url-rewrite feature.waf.web-application-firewall 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.

View a template for the features 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"
	}
]

history Object

The history object describes the policy's state changes using the following parameters:

Name	Data Type	Description
id	String	Identifies this entry by its system-defined ID.
type	String	Indicates the policy's new state. Valid values are: created \| deleted \| locked \| updated
created_at	String	Indicates the date and time (UTC) at which the policy entered the state identified by the state property. Syntax: YYYY-MM-DDThh:mm:ssZ Example: 2024-01-08T20:31:06Z
user	Object	Describes the user that requested the change in state.

user Object

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.
email	String	Indicates a user's email address.

Errors

The response body for an unsuccessful request will contain an error response that provides additional information.

Sample Request and Response

A sample JSON request is shown below.

PATCH https://api.vdms.io/rules-engine/v1.1/deploy-requests/35081 HTTP/1.1

Authorization: Bearer A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01z...A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01zOTIzQjI1MTYzRjU4MU1wQ0I3MUNBRDk3QjAzNkUwQjgiLCJ01XAiOiJKV1QiLCJ4NXQiOiJGMDc4bzVJN0pSWV9XQm9Ndcc5dGw3QTI0TGcifQ.1yJuYmYiOj11NjUzMDgwNzgsImV4cCI6MTU2NTMwODM3OCwiaXNzIjoiacR0ccM6Ly9pZC52ZG1zLmlvIiwiYXVkIjpbImc0dcBzOi8vaWQudmRtcy5pby9yZXNvdXJjZXMiLCJlYy5ydWxlcyJdLCJjbGllbnRfaWQiOiIxNTccOWZmZi04MTQzLTRmOW1tOWY1Yi1jNDgzZWVkNzclM2QiLCJzY29wZSI6WyJlYy5ydWxlcyJdfQ.XQ4TvzDrwLo4bO71cb1TbgYxmtcgTzC46Do0A9F3inAqw1qcr_Nr9IgRDxJDqR4Udc9QR86LVTQC2-ogGWP3pI12GtDtiUQdKYs5fpcuMf2Kbqau6kuU1M5BJm_GOcBNCCAJnU7SrDprVbPlwanGqk3yjcyo9nto8KWCRTwq2t31UQ1Ci31FZSr4vaMZJqk1vBW6NS3-yGowGCZbSIQBKpSgcc75coPtSjF1Qi6M4yORDyMC8c3KKlIp2b-6mpfDFXINIFV-XvnNuQ9v-lcc43_VWuDA_cQO8wmS4VzS1Ac1tpg1Pp4Bcdtjt12yKAXvi0X19R1BDmpxmO17cRRKYQ

Accept: application/json

Content-Type: application/json

Host: api.vdms.io

Content-Length: 81

{
    "state": "canceled",
    "message": "Last minute change to the policy"
}

A sample JSON response is shown below.

HTTP/1.1 202 Accepted

Cache-Control: private

Content-Type: application/json; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 1833

{
	"@id": "/rules-engine/v1.1/deploy-requests/35081",
	"@type": "DeployRequest",
	"id": "35081",
	"customer_id": "0001",
	"state": "canceled",
	"environment": "staging",
	"created_at": "2019-09-26T16:47:19Z",
	"updated_at": "2019-09-26T16:52:25Z",
	"is_visible": true,
	"policies": {
		"@id": "/rules-engine/v1.1/policies/20123",
		"@type": "Policy",
		"id": "20123",
		"name": "My Policy 1.00",
		"description": "",
		"policy_type": "customer",
		"state": "locked",
		"platform": "adn",
		"created_at": "2019-09-26T16:04:25Z",
		"updated_at": "2019-09-26T16:04:25Z",
		"rules": [{
				"@id": "/rules-engine/v1.1/policies/20123/rules/551519",
				"@type": "Rule",
				"id": "551519",
				"name": "",
				"description": "",
				"ordinal": 1,
				"created_at": "2019-09-26T16:04:25Z",
				"updated_at": "2019-09-26T16:04:25Z",
				"matches": [{
						"type": "match.always",
						"ordinal": 1,
						"features": [{
								"type": "feature.caching.external-max-age",
								"ordinal": 1,
								"value": "1",
								"units": "hours"
							}
						]
					}
				]
			}
		]
	},
    "history": [{
            "id": "67505",
            "state": "canceled",
            "created_at": "2019-09-26T16:52:25Z",
            "user": {
                "id": "344184",
                "first_name": "Joe",
                "last_name": "Smith",
                "email": "joe.smith@verizondigitalmedia.com"
            }
        }, {
			"id": "66491",
			"state": "submitted",
			"created_at": "2019-09-26T16:47:20Z",
			"user": {
				"id": "344184",
				"first_name": "Joe",
				"last_name": "Smith",
				"email": "joe.smith@example.com"
			}
		}
	],
	"user": {
		"id": "344184",
		"first_name": "Joe",
		"last_name": "Smith",
		"email": "joe.smith@example.com"
	}
}