Create an external resource
POST /tenancy/resource
Creates an external resource as a BlueXP resource. resourceType must be passed to the request.
Token usage: BlueXP user token.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
authorization |
string |
header |
True |
Authorization JWT access token |
X-Service-Request-Id |
string |
header |
False |
Request identifier |
Request Body
Name | Type | Required | Description |
---|---|---|---|
workspacePublicId |
string |
False |
|
agentId |
string |
True |
|
resourceIdentifier |
string |
False |
|
resourceType |
string |
False |
|
resourceClass |
string |
False |
|
cloudId |
string |
False |
|
name |
string |
False |
Example request
{
"workspacePublicId": "workspace-APWLzah1",
"agentId": "string",
"resourceIdentifier": "VsaWorkingEnvironment-yQFegzgz",
"resourceType": "string",
"resourceClass": "string",
"cloudId": "string",
"name": "string"
}
Response
Status: 200, Default response
Name | Type | Required | Description |
---|---|---|---|
accountPublicId |
string |
False |
|
resourcePublicId |
string |
False |
|
resourceIdentifier |
string |
False |
|
resourceType |
string |
False |
|
agentId |
string |
False |
|
resourceClass |
string |
False |
|
name |
string |
False |
|
cloudId |
string |
False |
|
agentIds |
array[string] |
False |
Example response
{
"accountPublicId": "string",
"resourcePublicId": "string",
"resourceIdentifier": "string",
"resourceType": "string",
"agentId": "string",
"resourceClass": "string",
"name": "string",
"cloudId": "string",
"agentIds": [
"string"
]
}
Definitions
See Definitions
body
Name | Type | Required | Description |
---|---|---|---|
workspacePublicId |
string |
False |
|
agentId |
string |
True |
|
resourceIdentifier |
string |
False |
|
resourceType |
string |
False |
|
resourceClass |
string |
False |
|
cloudId |
string |
False |
|
name |
string |
False |