API

Cloudlets API v3
Cloudlets API v2
- Rate limits
API summary
OpenAPI schema
Get started
Concepts
About group IDs
API workflow
API workflow for conditional origins
Interactions with Property Manager
Activation
Match rules
Match properties
Cloudlet-specific match examples
Errors
- 400
- 403
- 404
- 409
- 500

Cloudlets

Cloudlets
- List Cloudletsget
- Get a Cloudletget

Group-Level Cloudlets

Groups
- List groupsget
- Get a groupget

Policies

Policies

Policy versions

Policy versions
Version rules

Property Associations

Associated properties

Cloudlets origins for Application Load Balancer

Load balancing configurations
Conditional origins
- List conditional originsget
- Get a conditional originget
Load balancing versions

Load Balancer Activations

Load balancing activations

Policy Activations

Policy activations
- List policy activationsget
- Activate a policy versionpost

Schemas

Schemas
- List schemas per Cloudletget
- Get a schemaget

List groups

get https://{hostname}/cloudlets/api/v2/group-info

Returns information about the Cloudlet types associated with the groups you have edit privileges for.

Response

Response body

array of objects

object

groupId

integer

required

The ID of group.

groupName

string

required

The name of group.

parentId

integer

required

The ID of parent group.

capabilities

array of objects

required

Type and permission information for each cloudlet.

capabilities*

object

cloudletCode

string

required

The type of Cloudlet that this policy is for. To see the available Cloudlets, run the List Cloudlets operation. 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, and VP for Visitor Prioritization.

ALB AP AS CD ER FR IG VP

cloudletId

integer

required

The ID of cloudlet that this policy is for. The cloudletId for Edge Redirector is 0, Visitor Prioritization is 1, Forward Rewrite is 3, Request Control is 4, API Prioritization is 5, Audience Segmentation is 6, Phased Release is 7, and Application Load Balancer is 9. To see the available Cloudlets, run the List Cloudlets operation.

capabilities

array of strings

required

Possible permission values include: Activate, Edit, and View.

capabilities*

properties

array of strings | null

required

List of associated properties with this group.

properties*

location

string

required

The navigable endpoint used for the object referred to in the operation.

apiVersion

string

The specific version of this API.

serviceVersion

string | null

deprecated

The build of the software running on the server. The value can be null.

Updated about 1 year ago

Get a Cloudlet

Get a group

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/cloudlets/api/v2/group-info \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 1 year ago

Get a Cloudlet

Get a group

API
Cloudlets API v2
Rate limits
API summary
Get started
Concepts
About group IDs
API workflow
API workflow for conditional origins
Interactions with Property Manager
Activation
Test the activated policy
NetStorage activation considerations
Activate a policy version
Match rules
Match properties
Cloudlet-specific match examples
Errors
500
409
404
403
400

Cloudlets
Cloudlets
Get a Cloudletget
List Cloudletsget

Group-Level Cloudlets
Groups
Get a groupget
List groupsget

Policies
Policies
Update a policyput
Get a policyget
Remove a policydelete
Create a policypost
List policiesget

Policy versions
Policy versions
Remove a policy versiondelete
Update a policy versionput
Get a policy versionget
List policy versionsget
Create a new policy versionpost
Version rules
Update a version ruleput
Get a version ruleget
Add a version rulepost

Property Associations
Associated properties
Remove a property from a policydelete
Get associated properties for a policyget
List associated propertiesget

Cloudlets origins for Application Load Balancer
Load balancing configurations
Delete a load balancing configurationdelete
Update a load balancing configurationput
Create a load balancing configurationpost
Conditional origins
Get a conditional originget
List conditional originsget
Load balancing versions
Update a load balancing versionput
Get a load balancing versionget
List load balancing versionsget
Create a load balancing versionpost

Load Balancer Activations
Load balancing activations
Activate a load balancing versionpost
List activations for a load balancing configurationget
List current load balancing activationsget

Policy Activations
Policy activations
Activate a policy versionpost
List policy activationsget

Schemas
Schemas
Get a schemaget
List schemas per Cloudletget

200Returns information about the Cloudlet types that are associated with the groups that you have edit privileges for.