Cloudlets API Data Model

This section shows you the data model for the Cloudlets v2 API. The sections are organized based the standard workflow through this API.

In addition, JSON schemas are available for this API. See the JSON Schemas section for a list of schemas.

NOTE: See the Matches section for information about properties available for match rules.

CloudletInfo

The Cloudlet object (CloudletInfo) provides data about the Cloudlets enabled for an account.

When retrieving data for a single Cloudlet, the cloudletId is required. This property is returned when you run a GET for all Cloudlet information.

Sample GET response:

[
   {
      "apiVersion" : "2.0",
      "cloudletCode" : "FR",
      "cloudletId" : 3,
      "cloudletName" : "FORWARDREWRITE",
      "location" : "/api/v2/cloudlet-info/3",
      "serviceVersion" : null
   },
   {
      "apiVersion" : "2.0",
      "cloudletCode" : "ER",
      "cloudletId" : 0,
      "cloudletName" : "EDGEREDIRECTOR",
      "location" : "/api/v2/cloudlet-info/0",
      "serviceVersion" : null
   }
]

A 200 response message indicates the network successfully processed the request.

See HTTP Codes for a list of status codes returned with this API.

CloudletInfo Members

Member Type Description
Required
apiVersion String The specific version of this API.
cloudletCode Enumeration The two- or three- character code for the type of Cloudlet. Possible values include: ALB for Application Load Balancer, AP for API Prioritization, AS for Audience Segmentation, CD for Phased Release, ER for Edge Redirector, FR for Forward Rewrite, IG for Request Control, IV for Input Validation, and VP for Visitor Prioritization.
cloudletId Number An integer that corresponds to a Cloudlets policy type.
cloudletName Enumeration The full name of the Cloudlet. The available options for this field are APPLICATIONLOADBALANCER, ASSETPRIORITIZATION for API Prioritization, AUDIENCESEGMENTATION, CONTINUOUSDEPLOYMENT for Phased Release, EDGEREDIRECTOR, FORWARDREWRITE, INPUTVALIDATION, IPGEOACCESS for Request Control, , and VISITORPRIORITIZATION.
location String The navigable endpoint used for the object referred to in the operation.
Deprecated
serviceVersion String The build of the software running on the server.

GroupInfo

The Group-Level Cloudlet object (GroupInfo) provides data about the types of Cloudlets associated with the groups you have edit privileges for. This object supports GET requests that retrieve data either for all groups containing Cloudlets, or for a specific group.

When retrieving data for a single group, the groupId is required. Use -1 to request policies from your default group. The groupId is returned when you run a GET for all group information. For results to display, however, you must have edit privileges for one or more Cloudlet types within the group.

Sample GET response:

[
   {
      "apiVersion" : "2.0",
      "capabilities" : [
         {
            "capabilities" : [
               "View",
               "Edit",
               "Activate"
            ],
            "cloudletCode" : "ER",
            "cloudletId" : 0
         }
      ],
      "groupId" : 5678,
      "groupName" : "Subgroup 1",
      "location" : "/api/v2/group-info/5678",
      "parentId" : 1234,
      "properties" : ["www.example.com", "www.example.org"],
      "serviceVersion" : null
   }
]

GroupInfo Members

Member Type Description
Required
apiVersion String The specific version of this API.
capabilities GroupInfo.capabilities.[n] An array of type and permission information for each Cloudlet, as detailed below.
groupId Number The group association for the policy. If 0, the policy is not tied to a group and in effect appears in all groups for the account.
groupName String The name of the group.
location String The navigable endpoint used for the object referred to in the operation.
parentId Number The ID of the parent group. If you do not have edit permission for the parent group, this value is 0 and the parent group does not appear in the response.
properties Array An array of the properties associated with the selected group.
Deprecated
serviceVersion String The build of the software running on the server.

GroupInfo.capabilities.[n]  

Member Type Description
Required
capabilities Enumeration The permissions available for that Cloudlet. Possible values include: Activate, Edit, and View.
cloudletCode Enumeration The two- or three- character code for the type of Cloudlet. Possible values include: ALB for Application Load Balancer, AP for API Prioritization, AS for Audience Segmentation, CD for Phased Release, ER for Edge Redirector, FR for Forward Rewrite, IG for Request Control, IV for Input Validation, and VP for Visitor Prioritization.
cloudletId Number An integer that corresponds to a Cloudlets policy type.

Policy

The Cloudlet Policy object (Policy) allows you to create and manage your Cloudlet policies. When creating a Cloudlet policy, your request needs to include both the cloudletId (like 0 for Edge Redirector) and the groupId for the Cloudlet you are configuring. In addition, a name for the policy and a description are required.

Within a Cloudlet policy you set up specific versions, and within these versions you set up the match rules for governing how the Cloudlet is used.

Request and Response Examples

To create a new policy, you POST to the same endpoint from which you GET your full set of properties.

Sample GET response:

{
   "activations" : [
      {
         "apiVersion" : "2.0",
         "network" : "prod",
         "policyInfo" : {
            "activatedBy" : null,
            "activationDate" : 0,
            "detailCode" : 0,
            "name" : "TestCreatePolicy1",
            "policyId" : 1002,
            "status" : "INACTIVE",
            "statusDetail" : null,
            "version" : 0
         },
         "propertyInfo" : null,
         "serviceVersion" : null
      },
      {
         "apiVersion" : "2.0",
         "network" : "staging",
         "policyInfo" : {
            "activatedBy" : null,
            "activationDate" : 0,
            "detailCode" : 0,
            "name" : "TestCreatePolicy1",
            "policyId" : 1002,
            "status" : "INACTIVE",
            "statusDetail" : null,
            "version" : 0
         },
         "propertyInfo" : null,
         "serviceVersion" : null
      }
   ],
   "apiVersion" : "2.0",
   "cloudletCode" : "CC",
   "cloudletId" : 99,
   "createDate" : 1428957069841,
   "createdBy" : "jsmith",
   "deleted" : false,
   "description" : "Creating a policy",
   "groupId" : 1234,
   "lastModifiedBy" : "jsmith",
   "lastModifiedDate" : 1428957069841,
   "location" : "/api/v2/policies/1002",
   "name" : "CreatePolicy1",
   "policyId" : 1002,
   "propertyName" : null,
   "serviceVersion" : null
}

A 200 response message indicates the network successfully processed the request. A 201 response message indicates that a policy was successfully created.

See HTTP Codes for a list of status codes returned with this API.

Policy Members

Member Type Description
Optional
activations Policy.activations.[n] An array of current policy activation information, as detailed below.
apiVersion String The specific version of this API.
cloudletCode Enumeration The two- or three- character code for the type of Cloudlet. Possible values include: ALB for Application Load Balancer, AP for API Prioritization, AS for Audience Segmentation, CD for Phased Release, ER for Edge Redirector, FR for Forward Rewrite, IG for Request Control, IV for Input Validation, and VP for Visitor Prioritization.
cloudletId Number Required in POST request, unless you are cloning a policy. Defines the policy type. If you include this property in a clone request, the value must match the policy type of the policy being cloned. Use the Cloudlet Information operations to retrieve this value.
createdBy String The name of the user who created this specific policy.
createDate Number The date this specific policy was created (in milliseconds since Epoch).
deleted Boolean If true, the policy has been deleted.
description String The description of this specific policy.
groupId Number Required in POST request, unless you are cloning a policy. Defines the group association for the policy. You must have edit privileges for the group. If 0, the policy is not tied to a group and in effect appears in all groups for the account. Use -1 to request policies from your default group.
lastModifiedBy String The user who last modified the policy.
lastModifiedDate Number The date the initial policy was modified (in milliseconds since Epoch).
location String The navigable endpoint used for the object referred to in the operation.
matchRuleFormat String The version of the Cloudlet-specific matchRules.
matchRules Array A JSON structure that defines the rules for this policy. See Cloudlets API Match Rules for details.
name String Required in POST request. The name of the policy. The name must be unique.
policyId Number An integer ID that is associated with all versions of a policy.
rulesLocked Boolean If true, you cannot edit the match rules for the Cloudlet policy version.
Deprecated
propertyName String This property now only returns null. It does not reflect the properties currently associated with this Cloudlets policy.
serviceVersion String The build of the software running on the server.

Policy.activations.[n]  

Member Type Description
Required
network Enumeration The network, either staging or prod on which a property or a Cloudlets policy has been activated.
policyInfo Activation.policyInfo The object containing Cloudlet policy information, as detailed below.
propertyInfo Activation.propertyInfo The object containing information about the property associated with a particular Cloudlet policy, as detailed below.
Optional
apiVersion String The specific version of this API.
Deprecated
serviceVersion String The build of the software running on the server.

PolicyVersion

The Cloudlets Policy Version object (PolicyVersion) allows you to create and manage versions of your Cloudlet policies.

Sample GET response:

{
   "activations" : [
      {
         "apiVersion" : "2.0",
         "network" : "prod",
         "policyInfo" : {
            "activatedBy" : null,
            "activationDate" : 0,
            "detailCode" : 0,
            "name" : "CreatePolicy1",
            "policyId" : 1002,
            "status" : "INACTIVE",
            "statusDetail" : null,
            "version" : 2
         },
         "propertyInfo" : null,
         "serviceVersion" : null
      },
      {
         "apiVersion" : "2.0",
         "network" : "staging",
         "policyInfo" : {
            "activatedBy" : null,
            "activationDate" : 0,
            "detailCode" : 0,
            "name" : "CreatePolicy1",
            "policyId" : 1002,
            "status" : "INACTIVE",
            "statusDetail" : null,
            "version" : 2
         },
         "propertyInfo" : null,
         "serviceVersion" : null
      }
   ],
   "createDate" : 1428957891084,
   "createdBy" : "sjones",
   "description" : "New version of forwarding policy.",
   "lastModifiedBy" : "jsmith",
   "lastModifiedDate" : 1428957891084,
   "matchRules" : [],
   "policyId" : 1002,
   "revisionId" : 12345,
   "rulesLocked" : false,
   "version" : 2
}

PolicyVersion Members

Member Type Description
Optional
activations PolicyVersion.activations.[n] An array of activation information, as detailed below.
akaRuleId String The rule’s unique identifier.
createdBy String The name of the user who created this specific policy.
createDate Number The date this specific policy was created (in milliseconds since Epoch).
description String Required for POST request. The description of this specific policy.
lastModifiedBy String The user who last modified the policy.
lastModifiedDate Number The date the initial policy was modified (in milliseconds since Epoch).
matchRuleFormat String Required for POST request. The version of the Cloudlet-specific matchRules.
matchRules Array A JSON structure that defines the rules for this policy. See Cloudlets API Match Rules for details.
policyId Number An integer ID that is associated with all versions of a policy.
revisionId Number Unique ID given to every policy version update.
rulesLocked Boolean If true, you cannot edit the match rules for the Cloudlet policy version.
version String The version number of an activated policy (policyInfo) or property (propertyInfo).

PolicyVersion.activations.[n]  

Member Type Description
Optional
apiVersion String The specific version of this API.
network Enumeration The network, either staging or prod on which a property or a Cloudlets policy has been activated.
policyInfo Activation.policyInfo The object containing Cloudlet policy information, as detailed below.
propertyInfo Activation.propertyInfo The object containing information about the property associated with a particular Cloudlet policy, as detailed below.
Deprecated
serviceVersion String The build of the software running on the server.

PropertyAssociation

Use the Property Association object (PropertyAssociation) to find out which versions of a property that is associated with a Cloudlets policy is activated on the production and staging networks.

Sample GET response:

{
    "www.myproperty.com": {
        "groupId": 40498,
        "name": "www.myproperty.com",
        "newestVersion": {
            "activatedBy": "sjones",
            "activationDate": "2015-08-25",
            "cloudletsOrigins": {
                "nsorigin1": {
                    "id": "nsorigin1",
                    "hostname": "origin2.myproperty.com",
                    "checksum": "0edc0bb1be7439248a77f48e806d2531",
                    "type": "NETSTORAGE"
                },
                "clorigin1": {
                    "id": "clorigin1",
                    "hostname": "origin1.myproperty.com",
                    "checksum": "eefa90e680a1183725cfe2a1f00307c4",
                    "type": "CUSTOMER"
                }
            },
            "version": 5,
            "referencedPolicies": ["fr_policy_1"]
        },
        "production": {
            "activatedBy": "jsmith",
            "activationDate": "2015-08-26",
            "cloudletsOrigins": {
                "clorigin2": {
                    "id": "clorigin2",
                    "hostname": "origin2.myproperty.com",
                    "checksum": "0edc0bb1be7439248a77f48e806d2531",
                    "type": "NETSTORAGE"
                },
                "clorigin1": {
                    "id": "clorigin1",
                    "hostname": "origin1.myproperty.com",
                    "checksum": "eefa90e680a1183725cfe2a1f00307c4",
                    "type": "CUSTOMER"
                }
            },
            "version": 5,
            "referencedPolicies": ["fr_policy_1"]
        },
        "staging": {
            "activatedBy": "jsmith",
            "activationDate": "2015-08-25",
            "cloudletsOrigins": {
                "nsorigin1": {
                    "id": "nsorigin1",
                    "hostname": "origin2.myproperty.com",
                    "checksum": "0edc0bb1be7439248a77f48e806d2531",
                    "type": "NETSTORAGE"
                },
                "clorigin1": {
                    "id": "clorigin1",
                    "hostname": "origin1.myproperty.com",
                    "checksum": "eefa90e680a1183725cfe2a1f00307c4",
                    "type": "CUSTOMER"
                }
            },
            "version": 5,
            "referencedPolicies": ["fr_policy_1"]
        }
    }
}

PropertyAssociation Members

At the top level of the PropertyAssociation object is an arbitrary key that corresponds to the name of a property associated with one or more Cloudlets policies. This property may or may not have Cloudlets Origins configured on it.

This top-level object includes additional objects containing information about the latest version of the property, as well as its status on the production and staging environments. See PropertyAssociation.* below for a description of its members.

PropertyAssociation.*

Members Type Description
Required
groupId Number The group association for the property.
name String The name of the property. This value also appears at the start of each separate property object.
newestVersion PropertyAssociation.*.* An object that contains information about the newest property version.
production PropertyAssociation.*.* An object that contains information about the property’s current configuration on the production network.
staging PropertyAssociation.*.* An object that contains information about the property’s current configuration on the staging network.

PropertyAssociation.*.*

Members Type Description
Optional
activatedBy String The name of the user who activated property.
activationDate Number The date on which the property was activated (in ISO 8601 format).
cloudletsOrigins PropertyAssociation.*.*.cloudletsOrigins.* An object that contains information about each Cloudlets Origin configured on the property, as described below.
referencedPolicies Array The names of Cloudlets policies associated with this version of the property. All values in this array are strings. To retrieve policy information, construct a URL with one of the values listed and the id from the PropertyAssociation.*.*.cloudletsOrigins.* object.
version String The version number of the property.

PropertyAssociation.*.*.cloudletsOrigins.*

Members Type Description
Optional
checksum String The checksum that distinguishes this Cloudlets Origin from any others that might share the same name.
hostname String The name of the host that can be used as a Cloudlets Origin.
id String The Cloudlets Origin’s unique identifier.
type Enumeration The type of origin this Cloudlets Origin is set up as. Options are either CUSTOMER or NETSTORAGE.

CloudletsOrigin for Application Load Balancer

For the Application Load Balancer Cloudlet, use the Cloudlets Origin object (CloudletsOrigin) to view information about all types of Cloudlets Origins, and to set up and maintain load balancing configurations.

Load balancing configurations require a Cloudlets Origin with an originType of APPLICATION_LOAD_BALANCER.

NOTE: The /cloudlets/api/v2/conditional-origins?{policyId} endpoint that was previously used for Cloudlets Origins has been deprecated. See the Property Association Operations section for operations that return information about Cloudlets Origins.

Sample GET response:

[
    {
        "originId": "clorigin1",
        "checksum": "abcdefg1111hijklmn22222fff76yae3",
        "description": "Test load balancing configuration."
        "type": "APPLICATION_LOAD_BALANCER"
    }
]

CloudletsOrigin Members

Members Type Description
Optional
checksum String The checksum that distinguishes this Cloudlets Origin from any others that might share the same name.
hostname String The name of the host that can be used as a Cloudlets Origin.
originId String The Cloudlets Origin’s unique identifier.
type Enumeration The type of origin this Cloudlets Origin is set up as. Options are APPLICATION_LOAD_BALANCER, CUSTOMER, and NETSTORAGE.

LoadBalancingVersion

The Load Balancing Version (LoadBalancingVersion) object allows you to set up and maintain separate versions of load balancing configurations associated with a Cloudlets Origin. Only Cloudlets Origins with an originType of APPLICATION_LOAD_BALANCER support load balancing versions.

Sample GET response:

{
    "balancingType": "WEIGHTED",
    "createdBy": "jjones",
    "createdDate": "2015-10-08T11:42:18.690Z",
    "dataCenters": [
        {
            "cloudService": false,
            "livenessHosts": [
                "clorigin3.www.example.com",
            ],
            "latitude": 102.78108,
            "longitude": -116.07064,
            "continent": "NA",
            "country": "US",
            "originId": "clorigin3",
            "percent": 100.0
        }
    ],
    "deleted": false,
    "description": "Initial load balancing configuration for ALB rollout.",
    "immutable": false,
    "lastModifiedBy": "ejnovak",
    "lastModifiedDate": "2016-05-02T00:40:02.237Z",
    "livenessSettings": {
        "hostHeader": "clorigin3.www.example.com",
        "interval": 25,
        "path": "/directory/subdirectory",
        "port": 443,
        "protocol": "HTTPS",
        "status3xxFailure": false,
        "status4xxFailure": true,
        "status5xxFailure": false,
        "timeout": 30
    },
    "originId": "clorigin1",
    "version": 4
}

LoadBalancingVersion Members

Member Type Description
Required
balancingType Enumeration The type of load balancing being performed. Options include WEIGHTED and PERFORMANCE.
dataCenters LoadBalancingVersion.dataCenters.[n] The object containing information on Cloudlets Origins being used as data centers for an Application Load Balancer implementation, as detailed below. Only Cloudlets Origins with an originType of CUSTOMER or NETSTORAGE can be used as data centers in an Application Load Balancer configuration.
deleted Boolean If true, the Cloudlets Origin version has been deleted. If you set this member to false, you can use this version again.
description String The description of the load balancing configuration provided by a user.
Optional
createdBy String The name of the user who created this load balancing configuration.
createdDate String The date, in ISO 8601 format, when this load balancing configuration was created.
lastModifiedBy String The user who last modified the load balancing configuration.
lastModifiedDate String The date, in ISO 8601 format, when the initial load balancing configuration was last modified.
livenessSettings CloudletsOrigin.livenessSettings The object containing information on the liveness settings for an Application Load Balancer implementation, as detailed below.
originId String Unique identifier for the Cloudlets Origin that supports the load balancing configuration. The Cloudlets Origin must have an originType of APPLICATION_LOAD_BALANCER. The originType is defined in the Origin behavior.
version Number The version number of the load balancing configuration.

LoadBalancingVersion.dataCenters.[n]  

Member Type Description
Required
continent String The continent on which the data center is located. See Continent Codes for a list of valid codes.
country String The country in which the data center is located. See Country Codes for a list of valid codes.
latitude Number The latitude value for the data center. This member supports six decimal places of precision.
longitude Number The longitude value for the data center. This member supports six decimal places of precision.
originId String The ID of an origin that represents the data center. The Cloudlets Origin, which is defined in the Property Manager API, must have an originType of either CUSTOMER or NET_STORAGE. The originType is defined in the Origin behavior.
percent Number The percent of traffic that is sent to the data center. The total for all CloudletsOrigin.dataCenters.[n] objects within the array must equal 100%.
Optional
city String The city in which the data center is located.
cloudService Boolean If true caching for the data center is updated at a certain interval, like it would for a cloud-based service.
livenessHosts Array An array of strings that represent the origin servers used to poll the data centers in an Application Load Balancer configuration. These servers support basic HTTP polling.
stateOrProvince String The state, province, or region where the data center is located.

LoadBalancingVersion.livenessSettings

Member Type Description
Required
path String The path to the test object used for liveness testing. The function of the test object is to help determine whether the data center is functioning.
port Number The port for the test object. The default port is 80, which is standard for HTTP. Enter 443 if you are using HTTPS.
protocol Enumeration The protocol or scheme for the database, either HTTP or HTTPS.
status3xxFailure Boolean Set to true to mark the liveness test as failed when the request returns a 3xx (redirection) status code.
status4xxFailure Boolean Set to true to mark the liveness test as failed when the request returns a 4xx (client error) status code.
status5xxFailure Boolean Set to true to mark the liveness test as failed when the request returns a 5xx (server error) status code.
Optional
hostHeader String The value of the Host header of the domain that you are adding Application Load Balancer to. The Host header is the domain name without the scheme. For example, the hostheader for https://www.example.com would be www.example.com.
immutable Boolean Denotes whether you can edit the load balancing version. The default setting for this member is false. It automatically becomes true when the load balancing version is activated for the first time.
interval Number How often the liveness test occurs in seconds. Optional defaults to 60 seconds, minimum is 10 seconds.
timeout Number The number of seconds the system waits before failing the liveness test. The default is 25 seconds.

LoadBalancingVersionActivations

For the Application Load Balancer Cloudlet, use the Load Balancing Version Activation object (LoadBalancingVersionActivations) to activate a specific load balancing version on the network you select. Only Cloudlets Origins with an originType of APPLICATION_LOAD_BALANCER can support load balancing configurations.

Sample GET response:

[
    {
        "activatedBy": "jjones",
        "activatedDate": "2016-04-07T18:41:34.251Z",
        "network": "PRODUCTION",
        "originId": "clorigin1",
        "status": "active",
        "dryrun": false,
        "version": 1
    }
]

LoadBalancingVersion.activations

Member Type Description
Required
network Enumeration Required in POST request. The network, either STAGING or PRODUCTION, on which a load balancing configuration for Application Load Balancer has been activated.
originId String Unique identifier for the load balancing configuration.
version String The version number of the activated load balancing configuration.
Optional
activatedBy String The name of the user who activated the load balancing configuration.
activatedDate String The date, in ISO 8601 format, on which the load balancing configuration was activated.
dryrun Boolean If true, the operation validates the configuration, but does not activate the load balancing version. The default setting is false.
status Enumeration The activation status for the load balancing version. Values include the following: inactive where the load balancing version has not been activated. No active property versions reference this policy. active where the load balancing version is currently active (published) and its associated property version is also active. deactivated where the load balancing version was previously activated but it has been superseded by a more recent activation of another load balancing version. pending where the load balancing version is proceeding through the activation workflow. failed where the activation workflow for the load balancing version has failed.

Policy Activation

To use the Activation object (Activation), you need to know the version of the policy you want to activate or view. The version member, which is returned with policy version operations, provides this information.

Sample GET response:

[
    {
        "serviceVersion": null,
        "apiVersion": "2.0",
        "network": "staging",
        "policyInfo": {
            "policyId": 3235,
            "name": "sampleERpolicy",
            "version": 2,
            "status": "pending",
            "statusDetail": "File uploaded and awaiting validation",
            "detailCode": 1000,
            "activatedBy": "sjones",
            "activationDate": 1444929490000
        },
        "propertyInfo": {
            "name": "app_cloudlets.xml",
            "version": 1,
            "groupId": 40498,
            "status": "deactivated",
            "activatedBy": "jsmith",
            "activationDate": 1410825600000
        }
    }
]

Activation Members

Member Type Description
Optional
additionalPropertyNames Array An array of one or more additional properties that you want to activate with the Cloudlet policy. Once activated, the property and policy are permanently associated with each other.
apiVersion String The specific version of this API.
network Enumeration Required in POST request. The network, either staging or prod, on which a property or a Cloudlets policy has been activated.
policyInfo Activation.policyInfo The object containing Cloudlet policy information, as detailed below.
propertyInfo Activation.propertyInfo The object containing information about the property associated with a particular Cloudlet policy, as detailed below.
Deprecated
serviceVersion String The build of the software running on the server.

Activation.policyInfo

Member Type Description
Optional
activatedBy String The name of the user who activated the policy.
activationDate Number The date on which the policy was activated (in milliseconds since Epoch).
detailCode Number Akamai internal activation status codes.
name String The name of the policy.
policyId Number An integer ID that is associated with all versions of a policy.
status Enumeration The activation status for the policy or property. Values include the following: inactive where the policy version has not been activated. No active property versions reference this policy. active where the policy version is currently active (published) and its associated property version is also active. deactivated where the policy version was previously activated but it has been superseded by a more recent activation of another policy version. pending where the policy version is proceeding through the activation workflow. failed where the policy version activation workflow has failed.
statusDetail String Information about the status of an activation operation. Note that if a failure occurs and you are not sure of the cause, be sure to include the statusDetail and the status code from the response in any tickets you file.
version String The version number of the activated policy.

Activation.propertyInfo

Member Type Description
Optional
activatedBy String The name of the user who activated the property.
activationDate Number The date on which the property was activated (in milliseconds since Epoch).
groupId Number Defines the group association for the policy or property. If 0, the policy is not tied to a group and in effect appears in all groups for the account. You must have edit privileges for the group.
name String The name of the property.
status Enumeration The activation status for the policy or property. Values include the following: inactive where the policy version has not been activated. No active property versions reference this policy. active where the policy version is currently active (published) and its associated property version is also active. deactivated where the policy version was previously activated but it has been superseded by a more recent activation of another policy version. pending where the policy version is proceeding through the activation workflow. failed where the policy version activation workflow has failed.
version String The version number of the activated property.

JSON Schemas

The following JSON Schemas are available for this API:

Schema Type JSON Schema Name
Create a new policy create-policy.json
Update a policy update-policy.json
Clone an existing policy clone-policy.json
Create or clone a policy version create-nimbus_policy_version-cloudletType–1.0.json
Update a policy version update-nimbus_policy_version-cloudletType–1.0.json
Create or update a match rule match_rule-cloudletType–1.0.json

Sample GET response:

{
    "schemas": [
        {
            "title": "EDGE REDIRECTOR MATCH RULE",
            "version": "1.0",
            "location": "/api/v2/schemas/match_rule-ER-1.0.json",
            "description": "applied to create/update match rule requests for ER cloudlets, where requests are of the form: POST|PUT /api/v2/policies/{policyId}/versions/{versionId}/rules/{ruleId}",
            "additionalDescription": "null"
        },
        {
            "title": "CREATE/CLONE POLICY VERSION",
            "version": "1.0",
            "location": "/api/v2/schemas/create-nimbus_policy_version-ER-1.0.json",
            "description": "applied to create/clone policy version requests of form: POST /policies/{policyId}/versions ",
            "additionalDescription": "applied to policy version requests for ER cloudlets"
        },
        {
            "title": "UPDATE POLICY VERSION",
            "version": "1.0",
            "location": "/api/v2/schemas/update-nimbus_policy_version-ER-1.0.json",
            "description": "applied to update policy version requests of form: PUT /policies/{policyId}/versions/{versionId} ",
            "additionalDescription": "applied to policy version requests for ER cloudlets"
        },
        {
            "title": "CREATE POLICY",
            "version": "1.0",
            "location": "/api/v2/schemas/create-policy.json",
            "description": "applied to requests to create policies of the form: POST /cloudlets/api/v2/policies",
            "additionalDescription": "null"
        },
        {
            "title": "UPDATE POLICY",
            "version": "1.0",
            "location": "/api/v2/schemas/update-policy.json",
            "description": "applied to all requests to update policies of the form: PUT /cloudlets/api/v2/policies/{policyId}",
            "additionalDescription": "null"
        },
        {
            "title": "CLONE POLICY",
            "version": "1.0",
            "location": "/api/v2/schemas/clone-policy.json",
            "description": "applied to requests to clone policies of the form: POST /cloudlets/api/v2/policies?clonePolicyId=***",
            "additionalDescription": "null"
        }
    ]
}

Schema Members

Member Type Description
Optional
title String The title of the JSON schema.
version String The specific version of the JSON schema.
location String The network path for the JSON schema.
description String A description of when the JSON schema is applied.
additionalDescription String Cloudlet-specific information for the JSON schema.

Last modified: 1/9/2017