Get Rules by Edge CNAME

Returns a list of rules that meet the following conditions:

• The rule's policy is currently deployed to either the staging or production environment.
• The rule contains an Edge CNAME match condition set to the specified edge CNAME.

An edge CNAME cannot be deleted if it is in use by a policy deployed to the production or staging environment. Use this endpoint to find out which rules are still using that edge CNAME.

Request

Retrieve one or more rules via the following request:

HTTP Method	Request URI
GET	https://api.vdms.io/rules-engine/v1.1/rules/cnames/EdgeCNAMEID

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
EdgeCNAMEID Required	Replace this variable with the system-defined ID for the desired edge CNAME configuration. Retrieve edge CNAMEs and their system-defined IDs via the Get All Edge CNAMEs - ADN, Get All Edge CNAMEs - HTTP Large, and/or Get All Edge CNAMEs - HTTP Small endpoints.

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

Request body parameters are not required by this endpoint.

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 the requested endpoint.
@type	String	Returns CnameRuleIds.
ids	Array	Contains a list of IDs for rules that satisfy the request.
id	Integer	Identifies a rule by its system-defined ID. This rule must be active in either the staging or production environment and contain an Edge CNAME match condition set to the specified edge CNAME.

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.

A sample JSON response is shown below.

{
    "@id": "/rules-engine/v1.1/rules/cnames/123456",
    "@type": "CnameRuleIds",
    "ids": [
        {
            "id": 509073
        }
    ]
}