Discover an external resource
Suggest changes
POST /tenancy/resource/discover
Discovers an external resource to be added to BlueXP.
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 |
True |
|
agentId |
string |
True |
|
resourceIdentifier |
string |
True |
|
name |
string |
False |
|
resourceType |
string |
False |
|
resourceClass |
string |
False |
|
cloudId |
string |
False |
|
metadata |
False |
Example request
{
"workspacePublicId": "workspace-APWLzah1",
"agentId": "string",
"resourceIdentifier": "VsaWorkingEnvironment-yQFegzgz",
"name": "string",
"resourceType": "string",
"resourceClass": "string",
"cloudId": "string",
"metadata": {
"propertyName": "string",
"propertyValue": "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 |
|
cloudId |
string |
False |
|
metadata |
string |
False |
|
agentIds |
array[string] |
False |
Example response
{
"accountPublicId": "string",
"resourcePublicId": "string",
"resourceIdentifier": "string",
"resourceType": "string",
"agentId": "string",
"resourceClass": "string",
"cloudId": "string",
"metadata": "string",
"agentIds": [
"string"
]
}Definitions
See Definitions
metadata
| Name | Type | Required | Description |
|---|---|---|---|
propertyName |
string |
True |
|
propertyValue |
string |
True |
body
| Name | Type | Required | Description |
|---|---|---|---|
workspacePublicId |
string |
True |
|
agentId |
string |
True |
|
resourceIdentifier |
string |
True |
|
name |
string |
False |
|
resourceType |
string |
False |
|
resourceClass |
string |
False |
|
cloudId |
string |
False |
|
metadata |
False |