CloudDetail

Cloud detail endpoints

Get all Ubisoft cloud settings

get

Authorizations

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

application/json

idstringRead-onlyRequired

Ubisoft Cloud network setting id

projectIdstringRequired

Ubisoft Cloud project id

regionNamestringRequired

Ubisoft Cloud region name

publicNetworkIdstringRequired

Ubisoft Cloud public network UUID id e.g: (b091a99e-abdd-11ea-bb37-0242ac130002)

privateNetworkIdstringRequired

Ubisoft Cloud private network UUID id e.g: (d80e2d7e-aa38-490e-915c-bb56222911c3)

securityGroupIdstringRequired

Ubisoft Cloud security group id e.g: (0ec61726-405c-4919-b9a1-9dcd6ae56077)

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

changedAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/cloud/provider/uc/setting

GET /v3/cloud/provider/uc/setting HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "projectId": "text",
    "regionName": "text",
    "publicNetworkId": "text",
    "privateNetworkId": "text",
    "securityGroupId": "text",
    "createdAt": 1,
    "changedAt": 1
  }
]

Create Ubisoft cloud settings

post

Authorizations

PRIVATE-TOKENstringRequired

Body

idstringRead-onlyRequired

Ubisoft Cloud network setting id

projectIdstringRequired

Ubisoft Cloud project id

regionNamestringRequired

Ubisoft Cloud region name

publicNetworkIdstringRequired

Ubisoft Cloud public network UUID id e.g: (b091a99e-abdd-11ea-bb37-0242ac130002)

privateNetworkIdstringRequired

Ubisoft Cloud private network UUID id e.g: (d80e2d7e-aa38-490e-915c-bb56222911c3)

securityGroupIdstringRequired

Ubisoft Cloud security group id e.g: (0ec61726-405c-4919-b9a1-9dcd6ae56077)

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

changedAtinteger · integerRead-onlyRequired

UnixTimestamp

Responses

200

application/json

idstringRead-onlyRequired

Ubisoft Cloud network setting id

projectIdstringRequired

Ubisoft Cloud project id

regionNamestringRequired

Ubisoft Cloud region name

publicNetworkIdstringRequired

Ubisoft Cloud public network UUID id e.g: (b091a99e-abdd-11ea-bb37-0242ac130002)

privateNetworkIdstringRequired

Ubisoft Cloud private network UUID id e.g: (d80e2d7e-aa38-490e-915c-bb56222911c3)

securityGroupIdstringRequired

Ubisoft Cloud security group id e.g: (0ec61726-405c-4919-b9a1-9dcd6ae56077)

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

changedAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/cloud/provider/uc/setting

POST /v3/cloud/provider/uc/setting HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "projectId": "text",
  "regionName": "text",
  "publicNetworkId": "text",
  "privateNetworkId": "text",
  "securityGroupId": "text"
}

[
  {
    "id": "text",
    "projectId": "text",
    "regionName": "text",
    "publicNetworkId": "text",
    "privateNetworkId": "text",
    "securityGroupId": "text",
    "createdAt": 1,
    "changedAt": 1
  }
]

Get the detail of a Ubisoft cloud setting

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

ucSettingIdintegerRequired

The Id of the Ubisoft cloud setting

Responses

200

application/json

idstringRead-onlyRequired

Ubisoft Cloud network setting id

projectIdstringRequired

Ubisoft Cloud project id

regionNamestringRequired

Ubisoft Cloud region name

publicNetworkIdstringRequired

Ubisoft Cloud public network UUID id e.g: (b091a99e-abdd-11ea-bb37-0242ac130002)

privateNetworkIdstringRequired

Ubisoft Cloud private network UUID id e.g: (d80e2d7e-aa38-490e-915c-bb56222911c3)

securityGroupIdstringRequired

Ubisoft Cloud security group id e.g: (0ec61726-405c-4919-b9a1-9dcd6ae56077)

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

changedAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid ucSettingId

500

Internal Server Error

application/json

get

/v3/cloud/provider/uc/setting/{ucSettingId}

GET /v3/cloud/provider/uc/setting/{ucSettingId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "projectId": "text",
    "regionName": "text",
    "publicNetworkId": "text",
    "privateNetworkId": "text",
    "securityGroupId": "text",
    "createdAt": 1,
    "changedAt": 1
  }
]

Update the detail of a Ubisoft cloud setting

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

ucSettingIdintegerRequired

The Id of the Ubisoft cloud setting

Body

idstringRead-onlyRequired

Ubisoft Cloud network setting id

projectIdstringRequired

Ubisoft Cloud project id

regionNamestringRequired

Ubisoft Cloud region name

publicNetworkIdstringRequired

Ubisoft Cloud public network UUID id e.g: (b091a99e-abdd-11ea-bb37-0242ac130002)

privateNetworkIdstringRequired

Ubisoft Cloud private network UUID id e.g: (d80e2d7e-aa38-490e-915c-bb56222911c3)

securityGroupIdstringRequired

Ubisoft Cloud security group id e.g: (0ec61726-405c-4919-b9a1-9dcd6ae56077)

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

changedAtinteger · integerRead-onlyRequired

UnixTimestamp

Responses

200

application/json

idstringRead-onlyRequired

Ubisoft Cloud network setting id

projectIdstringRequired

Ubisoft Cloud project id

regionNamestringRequired

Ubisoft Cloud region name

publicNetworkIdstringRequired

Ubisoft Cloud public network UUID id e.g: (b091a99e-abdd-11ea-bb37-0242ac130002)

privateNetworkIdstringRequired

Ubisoft Cloud private network UUID id e.g: (d80e2d7e-aa38-490e-915c-bb56222911c3)

securityGroupIdstringRequired

Ubisoft Cloud security group id e.g: (0ec61726-405c-4919-b9a1-9dcd6ae56077)

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

changedAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid ucSettingId

500

Internal Server Error

application/json

put

/v3/cloud/provider/uc/setting/{ucSettingId}

PUT /v3/cloud/provider/uc/setting/{ucSettingId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "projectId": "text",
  "regionName": "text",
  "publicNetworkId": "text",
  "privateNetworkId": "text",
  "securityGroupId": "text"
}

[
  {
    "id": "text",
    "projectId": "text",
    "regionName": "text",
    "publicNetworkId": "text",
    "privateNetworkId": "text",
    "securityGroupId": "text",
    "createdAt": 1,
    "changedAt": 1
  }
]

Delete a given Ubisoft cloud setting

delete

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

ucSettingIdintegerRequired

The Id of the Ubisoft cloud setting

Responses

204

No Content

403

Invalid credentials

404

Invalid ucSettingId

500

Internal Server Error

application/json

delete

/v3/cloud/provider/uc/setting/{ucSettingId}

DELETE /v3/cloud/provider/uc/setting/{ucSettingId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Last updated 11 months ago

Was this helpful?