Skip to content
RuntaRunta
Start free with $50 credit

Create a runtime VNC credential

POST
/v2/runtimes/{runtime_id}/vnc-credentials
curl --request POST \
  --url https://api.runta.me/v2/runtimes/example/vnc-credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
runtime_id
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
display_name
required
string
>= 1 characters <= 100 characters
Examplegenerated
{
  "display_name": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Response envelope.

Media typeapplication/json
object
data
required
object
credential
required
object
id
required
string
display_name
required
string
locator
required
string
created_by_user_id
required
string
created_at
required
string format: date-time
last_used_at
string format: date-time
nullable
revoked_at
string format: date-time
nullable
username
required
string
password
required
string
hostname
required
string
port
required
integer format: uint16
>= 1 <= 65535
security_type
required
string
Allowed values: X509Plain
Example
{
  "data": {
    "security_type": "X509Plain"
  }
}

401

Section titled “401”

Missing, malformed, or rejected bearer token

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

403

Section titled “403”

The bearer token is not allowed to perform this action

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

404

Section titled “404”

The requested resource was not found

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

409

Section titled “409”

The request conflicts with current resource state

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

422

Section titled “422”

Validation or application error

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

501

Section titled “501”

Operation is not implemented

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

503

Section titled “503”

Upstream service is unavailable

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

504

Section titled “504”

Upstream request timed out

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

default

Section titled “default”

Error response

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}