Pitchfork - Databases

Instances

Check Instance If Root Enabled

/v1.0/{ddi}/instances/{instance_id}/root

Check if a database instance has root enabled. Returns True or False

View Documentation

	Parameter		Type	Required	Description
	instance_id		text	Yes	Database Instance UUID

* Required for API Call

Create Database/Replica/Backup Instance

/v1.0/{ddi}/instances

Creates a new database instance

View Documentation

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

Parameter	Type	Required	Description
flavor_id	integer	Yes	Flavor or Size ID Number
volume_size	integer	Yes	Size of instance in GB from 1 150 GB
instance_name	text	No	Name of instance
db_name	text	No	Name of Database
datastore_type	text	No	Type of datastore to use i.e. mysql, percona, etc.
datastore_version	text	No	Version number of datastore to use i.e. 5.1, 5.6 etc.
db_char_set	text	No	Character set for database. Default is utf8
db_collate_set	text	No	Collate set for database. Default is utf8_general_ci
user_name	text	No	Username of user
user_pass	text	No	Password of user
user_db_access	text	No	Database to allow user access to
backup_uuid	text	No	UUID of the backup to use to create this database
config_id	text	No	Configuration group ID
replication_source	text	No	Source Instance UUID to replicate

* Required for API Call

Delete Database Instance

/v1.0/{ddi}/instances/{instance_id}

Delete the specified database instance

View Documentation

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

	Parameter		Type	Required	Description
	instance_id		text	Yes	Database Instance UUID

* Required for API Call

Detach Replica

/v1.0/{ddi}/instances/{instance_id}

Detaches the specified replica instance from the replication source

View Documentation

Parameter	Type	Required	Description
instance_id	text	Yes	Replica Instance UUID to detach
replica_of	text	Yes	Source instance UUID
slave_of	text	Yes	Source instance UUID

* Required for API Call

Enable Root User

/v1.0/{ddi}/instances/{instance_id}/root

Enables the root user for the specified database instance

View Documentation

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

	Parameter		Type	Required	Description
	instance_id		text	Yes	Database Instance UUID

* Required for API Call

Get Database Instance/Replica Details

/v1.0/{ddi}/instances/{instance_id}

Lists status and details for specified database instance

View Documentation

	Parameter		Type	Required	Description
	instance_id		text	Yes	Database Instance ID

* Required for API Call

Get Default Config For Instance

/v1.0/{ddi}/instances/{instance_uuid}/configuration

Show the default configuration for the specified instance

View Documentation

	Parameter		Type	Required	Description
	instance_uuid		text	Yes	Instance UUID

* Required for API Call

List Database Instances/Replicas

/v1.0/{ddi}/instances

Lists the status and information for all database instances

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 Replicas For Instance

/v1.0/{ddi}/instances/{instance_id}/replicas

List all replicas for source instance

View Documentation

	Parameter		Type	Required	Description
	instance_id		text	Yes	Instance ID

* Required for API Call

Update Database Instance

/v1.0/{ddi}/instances/{instance_id}

Update the database instance i.e. attach or detach configuration group to instance

View Documentation

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

	Parameter		Type	Required	Description
	instance_id		text	Yes	Instance UUID
	config_id		text	No	Configuration group UUID

* Required for API Call

Databases

Create Database On Instance

/v1.0/{ddi}/instances/{instance_id}/databases

Creates a new database within the specified Instance

View Documentation

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

Parameter	Type	Required	Description
instance_id	text	Yes	Database Instance ID
db_name	text	Yes	Name of new Database
db_char_set	text	No	Database character set. Default is utf8
db_collate	text	No	Database collate set. Default is utf8_general_ci

* Required for API Call

Delete Database On Instance

/v1.0/{ddi}/instances/{instance_id}/databases/{db_name}

Delete the specified database on the given database instance.

View Documentation

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

	Parameter		Type	Required	Description
	instance_id		text	Yes	Database Instance UUID
	db_name		text	Yes	Name of the database to delete

* Required for API Call

List Databases For Given Instance

/v1.0/{ddi}/instances/{instance_id}/databases

List all databases for the specified instance

View Documentation

	Parameter		Type	Required	Description
	instance_id		text	Yes	Database Instance UUID

* Required for API Call

Actions

Resize (Ram) Database Instance

/v1.0/{ddi}/instances/{instance_id}/action

Resizes the memory allocation for the instance

View Documentation

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

	Parameter		Type	Required	Description
	instance_id		text	Yes	Database Instance ID
	flavor_ref_url		text	Yes	Flavor Reference URL

* Required for API Call

Resize (Volume) Database Instance

/v1.0/{ddi}/instances/{instance_id}/action

Resizes the database instance storage volume size. Note that you cannot decrease the size of the volume.

View Documentation

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

	Parameter		Type	Required	Description
	instance_id		integer	Yes	Database Instance UUID
	volume_size		integer	Yes	New volume size in GB from 1 to 150

* Required for API Call

Restart Database Instance

/v1.0/{ddi}/instances/{instance_id}/action

Restart the database service on the instance

View Documentation

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

	Parameter		Type	Required	Description
	instance_id		integer	Yes	Database Instance UUID

* Required for API Call

Users

Change Users Password On Instance

/v1.0/{ddi}/instances/{instance_id}/users

Changes the password for the specified instance and user

View Documentation

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

Parameter	Type	Required	Description
instance_id	text	Yes	Database Instance UUID
db_user	text	Yes	Username of user you are changing the password for
db_new_pass	text	Yes	New password for specified user

* Required for API Call

Create User On Instance

/v1.0/{ddi}/instances/{instance_id}/users

Create a user for the specified database instance

View Documentation

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

Parameter	Type	Required	Description
instance_id	text	Yes	Database Instance UUID
db_user	text	Yes	Username of User
db_pass	text	Yes	Password for User
db_name	text	No	Database Name to give access to
host	text	No	Specifies the host the user is allowed to connect from. Default is %

* Required for API Call

Delete User From Instance

/v1.0/{ddi}/instances/{instance_id}/users/{db_user}

Deletes the specified user from the specified database instance

View Documentation

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

	Parameter		Type	Required	Description
	instance_id		text	Yes	Database Instance UUID
	db_user		text	Yes

* Required for API Call

Grant User Access To Database

/v1.0/{ddi}/instances/{instance_id}/users/{db_user}/databases

Grants access to a database for the specified user on the specified instance

View Documentation

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

Parameter	Type	Required	Description
instance_id	text	Yes	Database Instance UUID
db_user	text	Yes	Username to grant access to database
db_name	text	Yes	Name of database to grant access to

* Required for API Call

List User Access To Databases

/v1.0/{ddi}/instances/{instance_id}/users/{db_user}/databases

Show list of all databases that the specified user has access to.

View Documentation

	Parameter		Type	Required	Description
	instance_id		text	Yes	Database Instance UUID
	db_user		text	Yes	Username to list accessible databases for

* Required for API Call

List User Details

/v1.0/{ddi}/instances/{instance_id}/users/{db_user}

List the specified users details, along with the database(s) that the user can access

View Documentation

	Parameter		Type	Required	Description
	instance_id		text	Yes	Database Instance UUID
	db_user		text	Yes	Username that you are getting details for

* Required for API Call

List User For Instance

/v1.0/{ddi}/instances/{instance_id}/users

List all users in the specified database instance

View Documentation

	Parameter		Type	Required	Description
	instance_id		text	Yes	Database Instance UUID

* Required for API Call

Modify User Attributes

/v1.0/{ddi}/instances/{instance_id}/users/{db_user}

Modifies user attributes on the given database instance

View Documentation

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

Parameter	Type	Required	Description
instance_id	text	Yes	Database Instance UUID
db_user	text	Yes	Username of user you want to change attributes for
db_new_user	text	No	New username for the specified user
db_new_pass	text	No	New password for the specified user
db_new_host	text	No	New Host from which the specified user can connect from

* Required for API Call

Revoke Access To Database

/v1.0/{ddi}/instances/{instance_id}/users/{db_user}/databases/{db_name}

Revoke access from specified user on a database within the specified instance.

View Documentation

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

Parameter	Type	Required	Description
instance_id	text	Yes	Database Instance UUID
db_user	text	Yes	User to revoke access for
db_name	text	Yes	Database to revoke access to

* Required for API Call

High Availability

Add Access Control List To Instance

/v1.0/{ddi}/ha/{ha_id}/acls

ADD ACL to HA instance

View Documentation

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

	Parameter		Type	Required	Description
	ha_id		text	Yes	HA instance ID
	address		text	Yes	IPv4 address CIDR notated. i.e. 192.168.1.0/24

* Required for API Call

Create High Availability Instance

/v1.0/{ddi}/ha

Create a new HA instance

View Documentation

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

Parameter	Type	Required	Description
datastore_type	text	Yes	Type of Datastore
datastore_version	text	Yes	Version of Datastore
ha_instance_name	text	Yes	Name of HA instance
replica_volume_size	integer	Yes	Size of replica in GB
replica_flavor_id	integer	Yes	Flavor of Replica
replica_name	text	Yes	Name of replica
replica_source_volume_size	integer	Yes	Size of Replica Source in GB
replica_source_flavor_id	integer	Yes	Flavor of replica source
replica_source_name	text	Yes	Name of replica source

* Required for API Call

Delete Access List From Instance

/v1.0/{ddi}/ha/{ha_id}/acls/{address}

Delete specified address from HA ACL list

View Documentation

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

	Parameter		Type	Required	Description
	ha_id		text	Yes	HA instance ID
	address		text	Yes	Address to remove. Use the following code for '/': %25252F i.e. 192.168.1.0%25252F24

* Required for API Call

Delete High Availability Database Instance

/v1.0/{ddi}/ha/{ha_id}

Delete specified HA instance

View Documentation

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

	Parameter		Type	Required	Description
	ha_id		text	Yes	HA instance ID

* Required for API Call

List Access List For High Availability Instance

/v1.0/{ddi}/ha/{ha_id}/acls

List all ACLs for an HA instance

View Documentation

	Parameter		Type	Required	Description
	ha_id		text	Yes	HA instance ID

* Required for API Call

List All High Availability Instances

/v1.0/{ddi}/ha

List High Availability Instance With Details

/v1.0/{ddi}/ha/{ha_id}

List HA instance with all details

View Documentation

	Parameter		Type	Required	Description
	ha_id		text	Yes	HA Instance ID

* Required for API Call

Backups

Create Backup

/v1.0/{ddi}/backups

Create backup for the specified database instance

View Documentation

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

Parameter	Type	Required	Description
backup_name	text	Yes	Name of the specified backup
instance_id	text	Yes	Database instance UUID
description	text	No	Long description for backup

* Required for API Call

Delete Backup

/v1.0/{ddi}/backups/{backup_id}

Delete the specified backup

View Documentation

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

	Parameter		Type	Required	Description
	backup_id		text	Yes	Backup UUID

* Required for API Call

List Backups

/v1.0/{ddi}/backups

List Backups By Id

/v1.0/{ddi}/backups/{backup_id}

List backups for the specified backup ID

View Documentation

	Parameter		Type	Required	Description
	backup_id		text	Yes	Backup UUID

* Required for API Call

List Backups For Instance

/v1.0/{ddi}/instances/{instance_id}/backups

List all backups for the specified database instance

View Documentation

	Parameter		Type	Required	Description
	instance_id		text	Yes	Database instance UUID

* Required for API Call

Scheduled Backups

Create Scheduled Backup

/v1.0/{ddi}/schedules

Create a scheduled backup for a particular instance

View Documentation

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

Parameter	Type	Required	Description
action	text	Yes	Action to perform
instance_id	text	No	Database instance ID
hour	integer	No	Hour to backup from 0 to 23. If not specified defaults to the current hour.
minute	integer	No	Minute to backup from 0 to 59. If not specified defaults to the current minute.
day_of_week	integer	No	Day of the week where Sunday is 0. Takes precedence over day_of_month. If not specified defaults to current day of the week.
month	integer	No	Month from 1 to 12
day_of_month	integer	No	Day of month from 1 to 31. day_of_week takes precedence over this value
source_id	text	No	Source UUID of the instance or HA Group ID HA
source_type	text	No	The type of backup for the given source_id
full_backup_retention	integer	No	Number of backups to retain

* Required for API Call

Delete Schedule

/v1.0/{ddi}/schedules/{schedule_id}

Delete the specified scheduled backup

View Documentation

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

	Parameter		Type	Required	Description
	schedule_id		text	Yes	Schedule ID

* Required for API Call

List Schedule Details

/v1.0/{ddi}/schedules/{schedule_id}

List details for the specified schedule

View Documentation

	Parameter		Type	Required	Description
	schedule_id		text	Yes	Schedule ID

* Required for API Call

List Scheduled Backups

/v1.0/{ddi}/schedules

Configurations

Create Configuration Group

/v1.0/{ddi}/configurations

Creates a new configurations group

View Documentation

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

Parameter	Type	Required	Description
config_name	text	Yes	Name of configuration
datastore_type	text	No	Type of datastore
datastore_version	text	No	Version of datastore
config_description	text	No	Description of custom configuration
connect_timeout	integer	No	Connection timeout in seconds
innodb_buffer_pool_size	integer	No	Innodb buffer pool size in kilobytes
join_buffer_size	integer	No	Join buffer size in kilobytes
key_buffer_size	integer	No	Key buffer size in kilobytes
max_allowed_packet	integer	No	Max allowed packet in kilobytes. Minimum is 1024
max_connections	integer	No	Max connections
max_user_connections	integer	No	Max user connections
wait_timeout	integer	No	Wait timeout in seconds

* Required for API Call

Delete Configuration Group

/v1.0/{ddi}/configurations/{config_id}

Delete the specified configuration group

View Documentation

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

	Parameter		Type	Required	Description
	config_id		text	Yes	Configuration group UUID

* Required for API Call

List Config Parameter Details

/v1.0/{ddi}/datastores/versions/{version_id}/parameters/{parameter_name}

List the configuration details for the specified parameter

View Documentation

	Parameter		Type	Required	Description
	version_id		text	Yes	Datastore version ID
	parameter_name		text	Yes	Parameter Name

* Required for API Call

List Configuration Details

/v1.0/{ddi}/configurations/{config_id}

List the details for the specified configuration group

View Documentation

	Parameter		Type	Required	Description
	config_id		text	Yes	Configuration group UUID

* Required for API Call

List Configuration Parameters

/v1.0/{ddi}/datastores/versions/{version_id}/parameters

List configuration parameters for the specified datastore version

View Documentation

	Parameter		Type	Required	Description
	version_id		text	Yes	Datastore version ID

* Required for API Call

List Configurations

/v1.0/{ddi}/configurations

List Default Configuration Parameters

/v1.0/{ddi}/datastore/version/{version_id}/configuration/{flavor_id}

List the default configuration parameters for the given datastore version and flavor

View Documentation

	Parameter		Type	Required	Description
	version_id		text	Yes	Version ID of datastore
	flavor_id		text	Yes	Flavor ID

* Required for API Call

List Instances For Configuration

/v1.0/{ddi}/configurations/{config_id}/instances

List all instances associated with the specified configuration group

View Documentation

	Parameter		Type	Required	Description
	config_id		text	Yes	Configuration group UUID

* Required for API Call

Replace All Configuration Parameters

/v1.0/{ddi}/configurations/{config_id}

Replace all of the configuration group parameters associated with the specified configuration group

View Documentation

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

Parameter	Type	Required	Description
config_id	text	Yes	Configuration group ID
config_name	text	Yes	Name of configuration group
config_description	text	No	Description of configuration group
connect_timeout	integer	No	Connection timeout in seconds
innodb_buffer_pool_size	integer	No	Innodb buffer pool size in kilobytes
join_buffer_size	integer	No	Join buffer size in kilobytes
key_buffer_size	integer	No	Key buffer size in kilobytes
max_allowed_packet	integer	No	Max allowed packet in kilobytes. Minimum is 1024
max_connections	integer	No	Max connections
max_user_connections	integer	No	Max user connections
wait_timeout	integer	No	Wait timeout in seconds

* Required for API Call

Update Some Config Parameters

/v1.0/{ddi}/configurations/{config_id}

Update some of the configuration parameters for the specified configuration group

View Documentation

Parameter	Type	Required	Description
config_id	text	Yes	Configuration group UUID
connect_timeout	integer	No	Connection timeout in seconds
innodb_buffer_pool_size	integer	No	Innodb buffer pool size in kilobytes
join_buffer_size	integer	No	Join buffer size in kilobytes
key_buffer_size	integer	No	Key buffer size in kilobytes
max_allowed_packet	integer	No	Max allowed packet in kilobytes. Minimum is 1024
max_connections	integer	No	Max connections
max_user_connections	integer	No	Max user connections
wait_timeout	integer	No	Wait timeout in seconds

* Required for API Call

Flavors

Get Flavor Details

/v1.0/{ddi}/flavors/{flavor_id}

Lists all information for the given database flavor ID

View Documentation

	Parameter		Type	Required	Description
	flavor_id		integer	Yes	Flavor ID

* Required for API Call

List Flavors

/v1.0/{ddi}/flavors

List Flavors For Datastore Version

/v1.0/{ddi}/datastores/{datastore_type}/versions/{version_id}/flavors

List all flavors for the given datastore and version

View Documentation

	Parameter		Type	Required	Description
	datastore_type		text	Yes	Datastore Type
	version_id		text	Yes	Version for the specified datastore

* Required for API Call

Types

List Datastore Types

/v1.0/{ddi}/datastores/{datastore_id}

List all datastore types for the specified datastore

View Documentation

	Parameter		Type	Required	Description
	datastore_id		text	Yes	Datastore ID

* Required for API Call

List Datastore Versions

/v1.0/{ddi}/datastores/{datastore_id}/versions

View the specified datastores available versions

View Documentation

	Parameter		Type	Required	Description
	datastore_id		text	Yes	ID for datastore

* Required for API Call

List Datastore Versions For Datastore

/v1.0/{ddi}/datastores/{datastore_id}/versions/{version_id}

List the versions for the specified datastore and version

View Documentation

	Parameter		Type	Required	Description
	datastore_id		text	Yes	Datastore ID
	version_id		text	Yes	Version ID

* Required for API Call

List Datastores

/v1.0/{ddi}/datastores

API Versions

List Versions

Databases - API Calls

Instances

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

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Databases

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