Pitchfork - Autoscale

Scaling Groups

Create Scaling Group

/v1.0/{ddi}/groups

Create scaling group based on the supplied arguments

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
launch_config_type	text	Yes	Launch configuration type
group_name	text	Yes	Name to give Scaling Group
group_cooldown	integer	Yes	Cooldown time in seconds before a new entitiy is created. Between 0 and 86400 seconds
group_min_entities	integer	Yes	Minimum number of entities in the scaling group
policy_name	text	Yes	Scaling policy name
policy_cooldown	integer	Yes	Cooldown period in seconds before the policy can be executed again. Between 0 and 86400 seconds
policy_type	text	Yes	Type of policy to be executed
policy_desired_capacity	integer	Yes	Desired server capacity of the group or how many servers are in the group
server_image_id	text	Yes	Server image UUID to use when scaling
server_flavor_id	text	Yes	Flavor ID to use when scaling
server_name	text	No	Name of server
server_disk_config	text	No	Server disk config
server_meta_key	text	No	Server meta key name
server_meta_value	text	No	Server meta value for key
server_network_uuid	text	No	Server network UUID to connect to server
server_personality_path	text	No	Personality path to place personality file
server_personality_contents	text	No	Personality contents base64 encoded
lb_port	integer	No	Port number to use on the new servers
lb_id	integer	No	Load Balancer numeric ID to add server to
group_max_entities	integer	No	Maximum allowed entities for group. Default is null or if specified must be between 0 - 1000
group_meta_key	text	No	Meta key name for scaling group
group_meta_value	text	No	Scaling group meta value for key
policy_change	integer	No	Change to make in the number of servers in the group. Positive increases and Negative decreases
policy_cron	text	No	Recurring time when the policy will be executed. Specified as a cron entry i.e. 0 * * * * (Cannot specify at if cron is used)
policy_at	text	No	Specifies the time the policy will be executed. Cannot specify cron when using at
user_data	text	No	Base64 encoded cloud-init file

* Required for API Call

Delete Scaling Group

/v1.0/{ddi}/groups/{group_id}

Delete the specified scaling group

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	group_id		text	Yes	Scaling group UUID

* Required for API Call

Delete Server From Scaling Group

/v1.0/{ddi}/groups/{group_id}/servers/{server_id}

Delete and replace or just delete a server from the specified scaling group.

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	group_id		text	Yes	Scaling group UUID
	server_id		text	Yes	Server UUID to remove. Add filter for replace=false if you do not wish to replace the server. By default the server will be replaced
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

Get Scaling Group State

/v1.0/{ddi}/groups/{group_id}/state

Get the current state of the specified scaling group

View Documentation

	Parameter		Type	Required	Description
	group_id		text	Yes	Scaling group UUID

* Required for API Call

List Group Details

/v1.0/{ddi}/groups/{group_id}

List all details about the specified scaling group

View Documentation

	Parameter		Type	Required	Description
	group_id		text	Yes	Scaling group UUID

* Required for API Call

List Scaling Groups

/v1.0/{ddi}/groups

List all scaling groups that are setup on the specified account

View Documentation

	Parameter		Type	Required	Description
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

Pause Scaling Group Policy Execution

/v1.0/{ddi}/groups/{group_id}/pause

Pause the execution of the specified scaling group policy

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	group_id		text	Yes	Scaling group UUID

* Required for API Call

Resume Scaling Group Policy Execution

/v1.0/{ddi}/groups/{group_id}/resume

Resume the execution of the specified scaling group.

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	group_id		text	Yes	Scaling group UUID

* Required for API Call

Configurations

Get Group Configuration

/v1.0/{ddi}/groups/{group_id}/config

Lists the configuration for the scaling group

View Documentation

	Parameter		Type	Required	Description
	group_id		text	Yes	Scaling group UUID

* Required for API Call

Get Launch Configuration

/v1.0/{ddi}/groups/{group_id}/launch

Lists details about the launch configuration for the specified scaling group.

View Documentation

	Parameter		Type	Required	Description
	group_id		text	Yes	Scaling group UUID

* Required for API Call

Replace Group Configuration

/v1.0/{ddi}/groups/{group_id}/config

Updates the configuration for the specified scaling group

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
group_id	text	Yes	Scaling group UUID
group_name	text	Yes	Name of Scaling Group
group_cooldown	integer	Yes	Specifies the cooldown period in seconds before more entities are added. Between 0 and 86400
group_min_entities	integer	Yes	Minimum number of entities in the scaling group
group_max_entities	integer	Yes	Maximum number of entities for this scaling group. Between 0 and 1000
group_meta_key	text	No	Group meta key name
group_meta_value	text	No	Group meta value for key

* Required for API Call

Replace Launch Config (Bfv)

/v1.0/{ddi}/groups/{group_id}/launch

Replace launch config with a boot from volume server

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
group_id	text	Yes	Scaling group UUID
server_flavor_id	text	Yes	Server Flavor ID
image_uuid	text	Yes	Image UUID to use to build the bootable volume
volume_size	text	Yes	Size of volume to create
image_source	text	Yes	Type of source the image is
boot_index	integer	Yes	Boot index of the volume. For BFV use 0
launch_type	text	Yes	Type of the launch configuration
destination_type	text	No	Destination type for the root partition
delete_on_term	boolean	No	Delete volume when server is deleted. For BFV use True to clean up the volume after a scale down.
server_name	text	No	Name of the server to use
server_meta_key	text	No	Server meta key name
server_meta_value	text	No	Server meta value for key
server_personality_path	text	No	Path to store personality file
server_personality_contents	text	No	Personality file contents base64 encoded
network_uuid	text	No	Network UUID to attach to server i.e. for SNET use 11111111-1111-1111-1111-111111111111
config_drive	text	No	Create config-drive
user_data	text	No	Data to be passed with config drive when set to True. Must be base64 encoded
key_name	text	No	Name of existing key on account
new_key_name	text	No	Name of the new key pair
new_public_key	text	No	New SSH public key
lb_id	integer	No	Load Balancer ID number to connect the server to
lb_port	integer	No	Load Balancer port number to use

* Required for API Call

Replace Launch Configuration

/v1.0/{ddi}/groups/{group_id}/launch

Update the launch configuration for the specified scaling group

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
group_id	text	Yes	Scaling group UUID
server_flavor_id	text	Yes	Server Flavor ID to use
server_image_id	text	Yes	Server image UUID to use
launch_type	text	Yes	Type of the launch configuration
server_name	text	No	Name of the server to use
server_disk_config	text	No	Server disk configuration
server_meta_key	text	No	Server meta key name
server_meta_value	text	No	Server meta value for key
server_personality_path	text	No	Path to store personality file
server_personality_contents	text	No	Personality file contents base64 encoded
network_uuid	text	No	Network UUID to attach to server i.e. for SNET use 11111111-1111-1111-1111-111111111111
config_drive	text	No	Create config-drive
user_data	text	No	Data to be passed with config drive when set to True. Must be base64 encoded
key_name	text	No	Name of existing key on account
new_key_name	text	No	Name of the new key pair
new_public_key	integer	No	New SSH public key
lb_id	integer	No	Load Balancer ID number to connect the server to
lb_port	integer	No	Load Balancer port number to use

* Required for API Call

Policies

Create Policy

/v1.0/{ddi}/groups/{group_id}/policies

Create a policy on the specified scaling group

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
group_id	text	Yes	Scaling group UUID
policy_name	text	Yes	Name of the policy
cooldown	integer	Yes	Cooldown period in second between 0 and 86400
policy_type	text	Yes	Type of policy being created
desired_capacity	integer	No	How many servers there should be in the scaling group. Must specify one of the following: desired capacity, change, or change percent
policy_change	integer	No	Change to make in the number of servers in the scaling group. Must specify one of the following: desired capacity, change, or change percent
policy_change_percent	float	No	Change percentage to make in the number of servers in the scaling group. Must specify one of the following: desired capacity, change, or change percent
policy_cron	text	No	Recurring time when the policy will be executed i.e. 0 * * * *
policy_at	text	No	Specifies the time at which to execute the policy. Cannot use both cron and at at the same time.

* Required for API Call

Delete Policy

/v1.0/{ddi}/groups/{group_id}/policies/{policy_id}

Delete the specified policy for the specified scaling group

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	group_id		text	Yes	Scaling group UUID
	policy_id		text	Yes	Policy UUID

* Required for API Call

Execute Policy

/v1.0/{ddi}/groups/{group_id}/policies/{policy_id}/execute

Execute the specified policy on the specified scaling group

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	group_id		text	Yes	Scaling group UUID
	policy_id		text	Yes	Policy UUID

* Required for API Call

Get Policies List

/v1.0/{ddi}/groups/{group_id}/policies

List all policies for the specified scaling group

View Documentation

	Parameter		Type	Required	Description
	group_id		text	Yes	Scaling group UUID

* Required for API Call

Get Policy Details

/v1.0/{ddi}/groups/{group_id}/policies/{policy_id}

Get details about the specified policy for the specified scaling group

View Documentation

	Parameter		Type	Required	Description
	group_id		text	Yes	Scaling group UUID
	policy_id		text	Yes	Policy UUID

* Required for API Call

Replace Policy

/v1.0/{ddi}/groups/{group_id}/policies/{policy_id}

Replace or update the specified policy for the specified scaling group

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
group_id	text	Yes	Scaling group UUID
policy_id	text	Yes	Policy UUID
policy_name	text	Yes	Name of the policy
cooldown	integer	Yes	Cooldown period in second between 0 and 86400
policy_type	text	Yes	Type of policy being created
desired_capacity	integer	No	How many servers there should be in the scaling group. Must specify one of the following: desired capacity, change, or change percent
policy_change	integer	No	Change to make in the number of servers in the scaling group. Must specify one of the following: desired capacity, change, or change percent
policy_change_percent	float	No	Change percentage to make in the number of servers in the scaling group. Must specify one of the following: desired capacity, change, or change percent
policy_cron	text	No	Recurring time when the policy will be executed i.e. 0 * * * *
policy_at	text	No	Specifies the time at which to execute the policy. Cannot use both cron and at at the same time.

* Required for API Call

Webhooks

Create A Webhook

/v1.0/{ddi}/groups/{group_id}/policies/{policy_id}/webhooks

Create a webhook for the specified policy on the specified scaling group

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
group_id	text	Yes	Scaling group UUID
policy_id	text	Yes	Policy UUID
webhook_name	text	Yes	Name for the webhook
webhook_meta_key	text	No	Meta key name for webhook not larger than 256 characters
webhook_meta_value	text	No	Meta value for key not exceeding 256 characters

* Required for API Call

Delete Webhook

/v1.0/{ddi}/groups/{group_id}/policies/{policy_id}/webhooks/{webhook_id}

Delete the specified webhook from the specfied policy on the specified scaling group

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
group_id	text	Yes	Scaling group UUID
policy_id	text	Yes	Policy UUID
webhook_id	text	Yes	Webhook UUID

* Required for API Call

Execute Anonymous Webhook

/v1.0/execute/{capability_version}/{capability_hash}

Executes an anonymous webhook

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	capability_version		text	Yes	Version for webhook listed in webhook details, list webhooks for policy, or on webhook create
	capability_hash		text	Yes	Hash for webhook listed in webhook details, list webhooks for policy, or on webhook create

* Required for API Call

Get Webhook Details

/v1.0/{ddi}/groups/{group_id}/policies/{policy_id}/webhooks/{webhook_id}

Get the details about the specified webhook for the specified policy on the specified scaling group

View Documentation

Parameter	Type	Required	Description
group_id	text	Yes	Scaling group UUID
policy_id	text	Yes	Policy UUID
webhook_id	text	Yes	Webhook UUID

* Required for API Call

List The Webhooks For Policy

/v1.0/{ddi}/groups/{group_id}/policies/{policy_id}/webhooks

List all the associated webhooks for the specified policy on the specified scaling group

View Documentation

	Parameter		Type	Required	Description
	group_id		text	Yes	Scaling group UUID
	policy_id		text	Yes	Policy UUID

* Required for API Call

Update Webhook

/v1.0/{ddi}/groups/{group_id}/policies/{policy_id}/webhooks/{webhook_id}

Update the specified webhook for the specified policy for the specified scaling group

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
group_id	text	Yes	Scaling group UUID
policy_id	text	Yes	Policy UUID
webhook_id	text	Yes	Webhook UUID
webhook_name	text	Yes	Name for webhook
webhook_meta_key	text	No	Meta key name not exceeding 256 characters
webhook_meta_value	text	No	Meta value for key not exceeding 256 characters

* Required for API Call

Limits

Get Limits

/v1.0/{ddi}/limits

Autoscale - API Calls

Scaling Groups

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Configurations

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Policies

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL