Organization API: Org Cloud Compute

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Org list templates

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org list templates

GET /api/v1/orgs/{org_slug}/vps/templates

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Org get instance

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org get instance

GET /api/v1/orgs/{org_slug}/vps/{uuid}

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Org list backups

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org list backups

GET /api/v1/orgs/{org_slug}/vps/{uuid}/backups

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Org create backup

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org create backup

POST /api/v1/orgs/{org_slug}/vps/{uuid}/backups

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json

Field	Type	Required
`note`	string or null	no
`mode`	string	no
`compress`	string	no

Responses

Section titled Org delete backup

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org delete backup

DELETE /api/v1/orgs/{org_slug}/vps/{uuid}/backups/{backup_id}

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`backup_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Org restore backup

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org restore backup

POST /api/v1/orgs/{org_slug}/vps/{uuid}/backups/{backup_id}/restore

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`backup_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Org bandwidth

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org bandwidth

GET /api/v1/orgs/{org_slug}/vps/{uuid}/bandwidth

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Org regenerate cloud init

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org regenerate cloud init

POST /api/v1/orgs/{org_slug}/vps/{uuid}/cloud-init/regenerate

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Org config

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org config

GET /api/v1/orgs/{org_slug}/vps/{uuid}/config

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Org console

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org console

GET /api/v1/orgs/{org_slug}/vps/{uuid}/console

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Org graphs

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org graphs

GET /api/v1/orgs/{org_slug}/vps/{uuid}/graphs

Parameters

Name	In	Type	Required	Description
`uuid`	path	string	yes
`org_slug`	path	string	yes
`timeframe`	query	string	no	Default: `hour`.

Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org guest

Section titled Org guest

GET /api/v1/orgs/{org_slug}/vps/{uuid}/guest

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Org hostname

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org hostname

PATCH /api/v1/orgs/{org_slug}/vps/{uuid}/hostname

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`hostname`	string	yes
`reboot`	boolean	no

Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org IPs

Section titled Org IPs

GET /api/v1/orgs/{org_slug}/vps/{uuid}/ips

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org power

Section titled Org power

POST /api/v1/orgs/{org_slug}/vps/{uuid}/power

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`action`	string	yes

Responses

Section titled Org rebuild

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org rebuild

POST /api/v1/orgs/{org_slug}/vps/{uuid}/rebuild

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`template_id`	integer	yes

Responses

Section titled Org rescue enter

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org rescue enter

POST /api/v1/orgs/{org_slug}/vps/{uuid}/rescue/enter

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`iso_volid`	string	yes

Responses

Section titled Org rescue exit

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org rescue exit

POST /api/v1/orgs/{org_slug}/vps/{uuid}/rescue/exit

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Org rescue media

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org rescue media

GET /api/v1/orgs/{org_slug}/vps/{uuid}/rescue/media

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Org reset password

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org reset password

POST /api/v1/orgs/{org_slug}/vps/{uuid}/reset-password

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Org list snapshots

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org list snapshots

GET /api/v1/orgs/{org_slug}/vps/{uuid}/snapshots

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Org create snapshot

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org create snapshot

POST /api/v1/orgs/{org_slug}/vps/{uuid}/snapshots

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`name`	string	yes
`description`	string or null	no
`vmstate`	boolean	no

Responses

Section titled Org delete snapshot

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org delete snapshot

DELETE /api/v1/orgs/{org_slug}/vps/{uuid}/snapshots/{snapshot_id}

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`snapshot_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Org rollback snapshot

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org rollback snapshot

POST /api/v1/orgs/{org_slug}/vps/{uuid}/snapshots/{snapshot_id}/rollback

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`snapshot_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Org SSH keys

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org SSH keys

PUT /api/v1/orgs/{org_slug}/vps/{uuid}/ssh-keys

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`ssh_keys`	string	no

Responses

Section titled Org status

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org status

GET /api/v1/orgs/{org_slug}/vps/{uuid}/status

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`org_slug`	path	string	yes

Responses