Skip to content
Coritan Docs

Organization API: Customer Portal: Vps

The 10 Organization API operations for vps.

View as Markdown

Part of Customer Portal.

Operations

Section titled Operations
Method Path Summary
GET /api/v1/orgs/{org_slug}/portal/vps/{uuid} Get instance
GET /api/v1/orgs/{org_slug}/portal/vps/{uuid}/bandwidth Get bandwidth
GET /api/v1/orgs/{org_slug}/portal/vps/{uuid}/console Console info
GET /api/v1/orgs/{org_slug}/portal/vps/{uuid}/credentials Credentials
GET /api/v1/orgs/{org_slug}/portal/vps/{uuid}/graphs Get graphs
PATCH /api/v1/orgs/{org_slug}/portal/vps/{uuid}/hostname Patch hostname
GET /api/v1/orgs/{org_slug}/portal/vps/{uuid}/ips List IPs
POST /api/v1/orgs/{org_slug}/portal/vps/{uuid}/power Power
POST /api/v1/orgs/{org_slug}/portal/vps/{uuid}/reset-password Reset password
GET /api/v1/orgs/{org_slug}/portal/vps/{uuid}/status Get status

Get instance

Section titled Get instance

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

Parameters

Section titled Parameters
Name In Type Required
uuid path string yes
org_slug path string yes

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

Get bandwidth

Section titled Get bandwidth

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

Parameters

Section titled Parameters
Name In Type Required
uuid path string yes
org_slug path string yes

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

Console info

Section titled Console info

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

Parameters

Section titled Parameters
Name In Type Required
uuid path string yes
org_slug path string yes

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

Credentials

Section titled Credentials

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

Parameters

Section titled Parameters
Name In Type Required
uuid path string yes
org_slug path string yes

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

Get graphs

Section titled Get graphs

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

Parameters

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

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

Patch hostname

Section titled Patch hostname

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

Parameters

Section titled Parameters
Name In Type Required
uuid path string yes
org_slug path string yes

Request body

Section titled Request body

application/json (required)

Field Type Required
hostname string yes
reboot boolean no

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

List IPs

Section titled List IPs

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

Parameters

Section titled Parameters
Name In Type Required
uuid path string yes
org_slug path string yes

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

Power

Section titled Power

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

Parameters

Section titled Parameters
Name In Type Required
uuid path string yes
org_slug path string yes

Request body

Section titled Request body

application/json (required)

Field Type Required
action string yes

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

Reset password

Section titled Reset password

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

Parameters

Section titled Parameters
Name In Type Required
uuid path string yes
org_slug path string yes

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

Get status

Section titled Get status

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

Parameters

Section titled Parameters
Name In Type Required
uuid path string yes
org_slug path string yes

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.