Pitchfork - Cloud Servers

Servers

Create Server

/v2/{ddi}/servers

Create Server with the specified image and flavor parameters

View Documentation

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

Parameter	Type	Required	Description
server_name	text	Yes	Name of Server
flavor_id	text	Yes	Flavor ID
image_id	text	No	Image UUID - This is required unless utilizing boot from volume
disk_config	text	No	Disk config setting
personality_path	text	No	Path to place personality file
personality_content	text	No	Base64 encoded personality content
network_uuid	text	No	Network UUID to attach server to
keypair_name	text	No	Name of the new key pair
public_key	text	No	SSH Public Key
key_name	text	No	Name of existing key on account
meta_key	text	No	Meta Key Name
meta_value	text	No	Meta Value for Key
config_drive	text	No	Create config-drive
user_data	text	No	Data to be passed with config drive when set to True
bfv_volume_uuid	text	No	Volume UUID already prepared for Boot from Volume
bfv_device_name	text	No	Device name where volume will be attached. Example: vda
bfv_source_type	text	No	Source type of volume such as snap, usually this can be left blank
bfm_delete_on_term	text	No	Delete volume when server is deleted. 0 for false, and 1 for true

* Required for API Call

Create Server (Bfv)

/v2/{ddi}/os-volumes_boot

Create 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
server_name	text	Yes	Name of Server
flavor_id	text	Yes	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
destination_type	text	No	Destination type for the root partition
delete_on_term	boolean	No	Delete volume when server is deleted
network_uuid	text	No	Network UUID to attach server to
keypair_name	text	No	Name of the new key pair
public_key	text	No	SSH Public Key
key_name	text	No	Name of existing key on account
meta_key	text	No	Meta Key Name
meta_value	text	No	Meta Value for Key
config_drive	text	No	Create config-drive
user_data	text	No	Data to be passed with config drive when set to True
personality_path	text	No	Path to place personality file
personality_content	text	No	Base64 encoded personality content

* Required for API Call

Delete Server

/v2/{ddi}/servers/{server_id}

Delete the specified server

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID

* Required for API Call

Get Server Details

/v2/{ddi}/servers/{server_id}

Get details about specified server

View Documentation

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID

* Required for API Call

List Servers

/v2/{ddi}/servers

List all servers in the given data center

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

List Servers With Details

/v2/{ddi}/servers/detail

List servers with all details included

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

Update Server

/v2/{ddi}/servers/{server_id}

Update server name, accessIPv4 and accessIPv6 ip addresses

View Documentation

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

Parameter	Type	Required	Description
server_id	text	Yes	Server UUID
server_name	text	No	New name of server
ip_v4	text	No	New IPv4 Server address
ip_v6	text	No	New IPv6 Server address

* Required for API Call

Actions

Change Administrator Password

/v2/{ddi}/servers/{server_id}/action

Changes the administrator password for a specified server

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID
	new_password		text	Yes	New Password for server

* Required for API Call

Confirm Resized Server

/v2/{ddi}/servers/{server_id}/action

Confirm the resize for a specified server

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID

* Required for API Call

Create Server Image

/v2/{ddi}/servers/{server_id}/action

Create image of the specified server

View Documentation

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

Parameter	Type	Required	Description
server_id	text	Yes	Server UUID
image_name	text	Yes	Name of Image
meta_key	text	No	Meta data key name
meta_value	text	No	Meta data value

* Required for API Call

Get Limits

/v2/{ddi}/limits

Get Vnc Console

/v2/{ddi}/servers/{server_id}/action

Retrieve the VNC console for the specified server

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID
	console_type		text	Yes

* Required for API Call

List Instance Actions

/v2/{ddi}/servers/{server_id}/os-instance-actions

View all actions against the specified instance

View Documentation

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID

* Required for API Call

Reboot Server

/v2/{ddi}/servers/{server_id}/action

Reboot the specified server

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID
	reboot_type		text	Yes	How to reboot the sytem

* Required for API Call

Rebuild Server

/v2/{ddi}/servers/{server_id}/action

Rebuild the specified server

View Documentation

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

Parameter	Type	Required	Description
server_id	text	Yes	Server UUID
server_name	text	Yes	Name of Server
image_uuid	text	Yes	Image UUID
flavor_id	text	No	Flavor ID
admin_password	text	No	Administrator password
disk_config	text	No	Disk config options
meta_key	text	No	Meta Data Key
meta_value	text	No	Meta Data Value
personality_path	text	No	Path to place the personality file
personality_contents	text	No	Base64 encoded file contents
access_ipv4	text	No	Access IPv4 address
access_ipv6	text	No	Access IPv6 address

* Required for API Call

Rescue Server

/v2/{ddi}/servers/{server_id}/action

Place the specified server in rescue mode

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID

* Required for API Call

Rescue Server With Specified Image

/v2/{ddi}/servers/{server_id}/action

Rescue cloud server specifying a specific omage UUID

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID to rescue
	rescue_image_uuid		text	Yes	Server image to use as rescue image

* Required for API Call

Reset Network

/v2/{ddi}/servers/{server_id}/action

Reset servers network based on original values at time of build. Do note that this will break RackConnectv2

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID

* Required for API Call

Resize Server

/v2/{ddi}/servers/{server_id}/action

Resize the specified server to the desited size

View Documentation

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

Parameter	Type	Required	Description
server_id	text	Yes	Server UUID
flavor_id	text	Yes	Flavor ID Number
server_name	text	No	Name of Resized Server
disk_config	text	No	Disk Config option

* Required for API Call

Revert Resized Server

/v2/{ddi}/servers/{server_id}/action

Revert the resize for the specified server

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID

* Required for API Call

Show Details For Instance Action

/v2/{ddi}/servers/{server_id}/os-instance-actions/{request_id}

Show details for the specified instance and specified request ID

View Documentation

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID
	request_id		text	Yes	Action request UUID

* Required for API Call

Stop Server

/v2/{ddi}/servers/{server_id}/action

Stop/shutdown the specified server

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID to perform action on

* Required for API Call

Unrescue Server

/v2/{ddi}/servers/{server_id}/action

Take the specified server out of rescue mode

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID

* Required for API Call

Metadata

Delete Image Metadata Item

/v2/{ddi}/images/{image_id}/metadata/{metadata_key}

Delete metadata item for the specified key on the specified server

View Documentation

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

	Parameter		Type	Required	Description
	image_id		text	Yes	Image UUID
	metadata_key		text	Yes	Metdata Key

* Required for API Call

Delete Server Metadata Item

/v2/{ddi}/servers/{server_id}/metadata/{metadata_key}

Delete specified metadata item on the specified server

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID
	metadata_key		text	Yes	Metadata Key

* Required for API Call

Get Image Metadata Item

/v2/{ddi}/images/{image_id}/metadata/{metadata_key}

Get metadata value for the specified image using the specified key

View Documentation

	Parameter		Type	Required	Description
	image_id		text	Yes	Image UUID
	metadata_key		text	Yes	Metadata Key

* Required for API Call

Get Server Metadata Item

/v2/{ddi}/servers/{server_id}/metadata/{metadata_key}

Get metadata value on the specified server using a specified key

View Documentation

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID
	metadata_key		text	Yes	Metadata Key

* Required for API Call

List Image Metadata

/v2/{ddi}/images/{image_id}/metadata

List the metadata for the associated image

View Documentation

	Parameter		Type	Required	Description
	image_id		text	Yes	Image UUID

* Required for API Call

List Server Metadata

/v2/{ddi}/servers/{server_id}/metadata

List the metadata associated with the specified server

View Documentation

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID

* Required for API Call

Set Image Metadata

/v2/{ddi}/images/{image_id}/metadata

Set metadata on the specified image

View Documentation

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

Parameter	Type	Required	Description
image_id	text	Yes	Image UUID
metadata_key	text	Yes	Metadata Key
metadata_value	text	Yes	Metadata Value

* Required for API Call

Set Image Metadata Item

/v2/{ddi}/images/{image_id}/metadata/{metadata_key}

Set metdata value for the specified key on the specified image

View Documentation

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

Parameter	Type	Required	Description
image_id	text	Yes	Image UUID
metadata_key	text	Yes	Metadata Key
metadata_value	text	Yes	Metadata Value

* Required for API Call

Set Server Metadata

/v2/{ddi}/servers/{server_id}/metadata

Set metadata on the specified server

View Documentation

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

Parameter	Type	Required	Description
server_id	text	Yes	Server UUID
metadata_key	text	Yes	Metadata Key
metadata_value	text	Yes	Metadata Value

* Required for API Call

Update Image Metadata

/v2/{ddi}/images/{image_id}/metadata

Update metadata on the specified image

View Documentation

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

Parameter	Type	Required	Description
image_id	text	Yes	Image UUID
metadata_key	text	Yes	Metadata Key
metadata_value	text	Yes	Metadata Value

* Required for API Call

Update Server Metadata

/v2/{ddi}/servers/{server_id}/metadata

Update metadata on the specified server

View Documentation

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

Parameter	Type	Required	Description
server_id	text	Yes	Server UUID
metadata_key	text	Yes	Metadata Key
metadata_value	text	Yes	Metadata Value

* Required for API Call

Update Server Metadata Key Value

/v2/{ddi}/servers/{server_id}/metadata/{metadata_key}

Set or change the value of a metadata key on the specified server

View Documentation

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

Parameter	Type	Required	Description
server_id	text	Yes	Server UUID
metadata_key	text	Yes	Metdata Key
metadata_value	text	Yes	Metadata Vlaue

* Required for API Call

Volumes

Attach Volume To Server

/v2/{ddi}/servers/{server_id}/os-volume_attachments

Attach CBS volume to specified server

View Documentation

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

Parameter	Type	Required	Description
server_id	text	Yes	Server UUID
volume_id	text	Yes	Volume UUID
dev_assignment	text	No	Attach to dev device i.e. /dev/xvdb

* Required for API Call

Delete Volume Attachement

/v2/{ddi}/servers/{server_id}/os-volume_attachments/{volume_id}

Detach/Delete volume attachment from specified server

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID
	volume_id		text	Yes	Volume UUID

* Required for API Call

Get Volume Attachment Details

/v2/{ddi}/servers/{server_id}/os-volume_attachments/{attachment_id}

Get the attached specified volume details on the specified server

View Documentation

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID
	attachment_id		text	Yes	Volume Attachment ID

* Required for API Call

List Attached Volumes

/v2/{ddi}/servers/{server_id}/os-volume_attachments

List attached volumes to the specified server

View Documentation

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID

* Required for API Call

Unattach Volume From Server

/v2/{ddi}/servers/{server_id}/os-volume_attachments/{attachment_id}

Removes the specified volume from the specified server

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID
	attachment_id		text	Yes	Attachment ID

* Required for API Call

Networks

Attach Virtual Interface

/v2/{ddi}/servers/{server_id}/os-virtual-interfacesv2

Creates a virtual interface for a network and attaches the network to the specified server instance

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID
	network_id		text	Yes	Network UUID

* Required for API Call

List Virtual Interfaces

/v2/{ddi}/servers/{server_id}/os-virtual-interfacesv2

List the virtual interfaces configured for a specified server instance

View Documentation

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID

* Required for API Call

Unattach Virtual Interface

/v2/{ddi}/servers/{server_id}/os-virtual-interfacesv2/{interface_id}

Delete the specified virtual interface on the specified server

View Documentation

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

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID
	interface_id		text	Yes	Virtual Interface UUID

* Required for API Call

Images

Delete Image

/v2/{ddi}/images/{image_id}

Delete the specified image

View Documentation

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

	Parameter		Type	Required	Description
	image_id		text	Yes	Image UUID

* Required for API Call

Get Image Details

/v2/{ddi}/images/{image_id}

Get details of specified image

View Documentation

	Parameter		Type	Required	Description
	image_id		text	Yes	Image UUID

* Required for API Call

List Images

/v2/{ddi}/images

List all images available to create a server from

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

List Images With Details

/v2/{ddi}/images/detail

List all images including all details

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

Flavors

Get Flavor Details

/v2/{ddi}/flavors/{flavor_id}

Get details about a specified flavor

View Documentation

	Parameter		Type	Required	Description
	flavor_id		integer	Yes	Flavor ID Number

* Required for API Call

List Flavors

/v2/{ddi}/flavors

List Flavors available to build (RAM and Disk Size)

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

Addresses

List Addresses

/v2/{ddi}/servers/{server_id}/ips

List all networks and server addresses for the specified server

View Documentation

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID

* Required for API Call

List Addresses By Network

/v2/{ddi}/servers/{server_id}/ips/{network_label}

List addresses associated with a specified server and network

View Documentation

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID
	network_label		text	Yes	Network label i.e. public or private

* Required for API Call

Key Pairs

Create Server Key Pair

/v2/{ddi}/os-keypairs

Create rsa key to use for passwordless authentication

View Documentation

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

	Parameter		Type	Required	Description
	keypair_name		text	Yes	Name of the specified key pair

* Required for API Call

Delete Server Key Pair

/v2/{ddi}/os-keypairs/{keypair_name}

Delete the specified key pair

View Documentation

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

	Parameter		Type	Required	Description
	keypair_name		text	Yes	Key pair name to delete

* Required for API Call

List Server Key Pairs

/v2/{ddi}/os-keypairs

Upload Server Key Pair

/v2/{ddi}/os-keypairs

Uploads an existing key of the specified name to associate with new instances

View Documentation

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

	Parameter		Type	Required	Description
	keypair_name		text	Yes	Name of key pair
	public_key		text	Yes	Existing public key

* Required for API Call

Cloud Servers - API Calls

Servers

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

Actions

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

Request URL

Request Headers