CloudCredentials

Configure your cloud credentials

Get list of cloud provider credentials

get

For a list of cloud providers see GET /v3/cloud/provider

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

providerIdinteger · integerRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

namestringRequired

User defined name for the cloud credential

paramsany ofRequired

Cloud provider specific authentication params, in json format. API examples

or

or

or

createdAtinteger · integerRead-onlyRequired

Unix timestamp of when credentials were first stored (informative only)

verifiedAtinteger · integerRead-onlyRequired

Unix timestamp of credential last verification time (informative only)

credentialStatusinteger · integerRead-onlyRequired

Status of cloud credential

• 0: valid
• 1: invalid

invalidateAtinteger · integerRead-onlyRequired

Unix timestamp of invalidation

invalidateReasonstringRead-onlyRequired

The reason for invalidation of the cloud credential

statusinteger · integerRequired

Status of a currently in use cloud credential

• 0: inactive
• 1: active

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/cloud/configuration/credential

HTTPcURLJavaScriptPython

GET /v3/cloud/configuration/credential HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "providerId": 1,
    "name": "text",
    "params": {
      "accessKeyId": "text",
      "secretAccessKey": "text",
      "defaultRegion": "text",
      "keyPair": "text",
      "securityGroup": "text",
      "isGameLift": true
    },
    "createdAt": 1,
    "verifiedAt": 1,
    "credentialStatus": 1,
    "invalidateAt": 1,
    "invalidateReason": "text",
    "status": 1
  }
]

Store new cloud provider credentials

post

For a list of cloud providers see GET /v3/cloud/provider. In order to use your account for ODP you need to have permissions access, create and control instance templates and instances. If you are not sure which permissions you need, please contact [email protected].

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

providerIdinteger · integerRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

namestringRequired

User defined name for the cloud credential

paramsany ofRequired

Cloud provider specific authentication params, in json format. API examples

or

or

or

createdAtinteger · integerRead-onlyRequired

Unix timestamp of when credentials were first stored (informative only)

verifiedAtinteger · integerRead-onlyRequired

Unix timestamp of credential last verification time (informative only)

credentialStatusinteger · integerRead-onlyRequired

Status of cloud credential

• 0: valid
• 1: invalid

invalidateAtinteger · integerRead-onlyRequired

Unix timestamp of invalidation

invalidateReasonstringRead-onlyRequired

The reason for invalidation of the cloud credential

statusinteger · integerRequired

Status of a currently in use cloud credential

• 0: inactive
• 1: active

Responses

200

OK

application/json

providerIdinteger · integerRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

namestringRequired

User defined name for the cloud credential

paramsany ofRequired

Cloud provider specific authentication params, in json format. API examples

or

or

or

createdAtinteger · integerRead-onlyRequired

Unix timestamp of when credentials were first stored (informative only)

verifiedAtinteger · integerRead-onlyRequired

Unix timestamp of credential last verification time (informative only)

credentialStatusinteger · integerRead-onlyRequired

Status of cloud credential

• 0: valid
• 1: invalid

invalidateAtinteger · integerRead-onlyRequired

Unix timestamp of invalidation

invalidateReasonstringRead-onlyRequired

The reason for invalidation of the cloud credential

statusinteger · integerRequired

Status of a currently in use cloud credential

• 0: inactive
• 1: active

403

Invalid credentials

409

Conflict

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/cloud/configuration/credential

HTTPcURLJavaScriptPython

POST /v3/cloud/configuration/credential HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 179

{
  "providerId": 1,
  "name": "text",
  "params": {
    "accessKeyId": "text",
    "secretAccessKey": "text",
    "defaultRegion": "text",
    "keyPair": "text",
    "securityGroup": "text",
    "isGameLift": true
  },
  "status": 1
}

[
  {
    "providerId": 1,
    "name": "text",
    "params": {
      "accessKeyId": "text",
      "secretAccessKey": "text",
      "defaultRegion": "text",
      "keyPair": "text",
      "securityGroup": "text",
      "isGameLift": true
    },
    "createdAt": 1,
    "verifiedAt": 1,
    "credentialStatus": 1,
    "invalidateAt": 1,
    "invalidateReason": "text",
    "status": 1
  }
]

Get a list of cloud provider credentials for a given credential name

get

For a list of cloud providers see GET /v3/cloud/provider

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

credentialNamestringRequired

The user defined name for cloud credentials

Responses

200

OK

application/json

providerIdinteger · integerRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

namestringRequired

User defined name for the cloud credential

paramsany ofRequired

Cloud provider specific authentication params, in json format. API examples

or

or

or

createdAtinteger · integerRead-onlyRequired

Unix timestamp of when credentials were first stored (informative only)

verifiedAtinteger · integerRead-onlyRequired

Unix timestamp of credential last verification time (informative only)

credentialStatusinteger · integerRead-onlyRequired

Status of cloud credential

• 0: valid
• 1: invalid

invalidateAtinteger · integerRead-onlyRequired

Unix timestamp of invalidation

invalidateReasonstringRead-onlyRequired

The reason for invalidation of the cloud credential

statusinteger · integerRequired

Status of a currently in use cloud credential

• 0: inactive
• 1: active

403

Invalid credentials

404

Invalid credentialName

500

Internal Server Error

application/json

get

/v3/cloud/configuration/credential/{credentialName}

HTTPcURLJavaScriptPython

GET /v3/cloud/configuration/credential/{credentialName} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "providerId": 1,
    "name": "text",
    "params": {
      "accessKeyId": "text",
      "secretAccessKey": "text",
      "defaultRegion": "text",
      "keyPair": "text",
      "securityGroup": "text",
      "isGameLift": true
    },
    "createdAt": 1,
    "verifiedAt": 1,
    "credentialStatus": 1,
    "invalidateAt": 1,
    "invalidateReason": "text",
    "status": 1
  }
]

Update name and status of credential.

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

credentialNamestringRequired

The user defined name for cloud credentials.

Body

application/json

namestringRequired

User defined name for the cloud credential

statusinteger · integerRequired

Status of a cloud credential

• 0: inactive
• 1: active

Responses

200

OK

application/json

namestringRequired

User defined name for the cloud credential

statusinteger · integerRequired

Status of a cloud credential

• 0: inactive
• 1: active

403

Invalid credentials

404

Invalid credentialName

409

Name already exists

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/cloud/configuration/credential/{credentialName}

HTTPcURLJavaScriptPython

PUT /v3/cloud/configuration/credential/{credentialName} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "name": "text",
  "status": 1
}

[
  {
    "name": "text",
    "status": 1
  }
]

Delete a cloud provider credential for a given name

delete

For a list of cloud providers see GET /v3/cloud/provider

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

credentialNamestringRequired

The user defined name for cloud credentials.

Responses

204

No Content

403

Invalid credentials

404

Invalid credentialName

500

Internal Server Error

application/json

delete

/v3/cloud/configuration/credential/{credentialName}

HTTPcURLJavaScriptPython

DELETE /v3/cloud/configuration/credential/{credentialName} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Validate cloud provider credentials

post

For a list of cloud providers see GET /v3/cloud/provider. In order to use your account for the One Platform you need to have permissions to access, create and control instance templates and instances. If you are not sure which permissions you need, please contact [email protected]. This endpoint only validates provided cloud credentials, this action won't create new cloud credentials for your user (to do so please refer to POST /cloud/configuration/credential)

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

providerIdinteger · integerRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

paramsany ofRequired

Cloud provider specific authentication params, in json format. API examples

or

or

or

Responses

204

No Content

403

Invalid credentials

409

Conflict

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/cloud/configuration/credential/validate

HTTPcURLJavaScriptPython

POST /v3/cloud/configuration/credential/validate HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "providerId": 1,
  "params": {
    "accessKeyId": "text",
    "secretAccessKey": "text",
    "defaultRegion": "text",
    "keyPair": "text",
    "securityGroup": "text",
    "isGameLift": true
  }
}

No content