Credentials Manager

This resource collection represents credential sets used to access connected objects.

Get Credential Sets

Returns a collection resource representations of all credential sets.

SecurityBearer

Request

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Responses

200

Success

403

Forbidden

get/api/v2.3/credentials

Request samples

curl

Response samples

application/json

{"items": [{"credentialsId": 12,
"type": "Password",
"userName": "TECH\\administrator",
"description": "vCenter Server service account",
"lastModified": "2026-01-15T10:24:33Z",
"currentlyAssigned": true,
"isPropagated": false
},
{"credentialsId": 15,
"type": "SshKey",
"userName": "root",
"description": "Linux guest OS access",
"lastModified": "2026-01-12T08:15:00Z",
"currentlyAssigned": true,
"isPropagated": true
}
],
"totalCount": 2
}

Create Credential Set

Creates a new credential set.

SecurityBearer

Request

Request Body schema: application/json

type required	string non-empty Default: "Password" Type of credentials.
userName	string or null [ 0 .. 100 ] characters User name.
password	string or null [ 0 .. 255 ] characters Password.
description	string or null [ 0 .. 1000 ] characters Description.
sshKey	string or null SSH key.
sshKeyPassword	string or null SSH key password.

Responses

200

Success

403

Forbidden

post/api/v2.3/credentials

Request samples

Payload
curl

application/json

{"type": "Password",
"userName": "TECH\\administrator",
"password": "P@ssw0rd!",
"description": "vCenter Server service account",
"sshKey": null,
"sshKeyPassword": null
}

Response samples

application/json

{"credentialsId": 12,
"type": "Password",
"userName": "TECH\\administrator",
"description": "vCenter Server service account",
"lastModified": "2026-01-15T10:24:33Z",
"currentlyAssigned": true,
"isPropagated": false
}

Get Hosts Accessed with Credential Set

Returns a collection resource representation of hosts that are accessed with the credential set with the specified ID.

SecurityBearer

Request

path Parameters

credentialId

required

integer <int64>

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Responses

200

Success

403

Forbidden

get/api/v2.3/credentials/{credentialId}/assign/host

Request samples

curl

Response samples

application/json

{"credentialId": 12,
"userName": "TECH\\administrator",
"assignedObjects": [{"objectId": 1024,
"objectName": "vcenter01.tech.local",
"objectType": "VwVCenter"
},
{"objectId": 1050,
"objectName": "esx03.tech.local",
"objectType": "VwEsx"
}
]
}

Assign Credentials to Host

Assigns a credential set to a host with the specified ID.

SecurityBearer

Request

path Parameters

credentialId

required

integer <int64>

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Request Body schema: application/json

objectId	integer <int64> ID assigned to a host
propagate	boolean Defines whether credentials must be propagated to host child objects.
port	integer or null <int32> Host connection port.

Responses

200

Success

403

Forbidden

post/api/v2.3/credentials/{credentialId}/assign/host

Request samples

Payload
curl

application/json

{"objectId": 1024,
"propagate": true,
"port": 443
}

Response samples

application/json

{"credentialId": 12,
"userName": "TECH\\administrator",
"assignedObjects": [{"objectId": 1024,
"objectName": "vcenter01.tech.local",
"objectType": "VwVCenter"
},
{"objectId": 1050,
"objectName": "esx03.tech.local",
"objectType": "VwEsx"
}
]
}

Get VMs Accessed with Credential Set

Returns a collection resource representation of VMs that are accessed with the guest OS credential set with the specified ID.

SecurityBearer

Request

path Parameters

credentialId

required

integer <int64>

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Responses

200

Success

403

Forbidden

get/api/v2.3/credentials/{credentialId}/assign/guest

Request samples

curl

Response samples

application/json

{"credentialId": 15,
"userName": "root",
"assignedObjects": [{"objectId": 2048,
"objectName": "linux-web01.tech.local",
"objectType": "VwVm",
"guestAssign": "GuestLinux",
"settingsInfo": {"sshPort": 22,
"sshSkipVerification": false
}
}
]
}

Assign Credentials to VM

Assigns a credential set to a guest OS of a VM with the specified ID.

SecurityBearer

Request

path Parameters

credentialId

required

integer <int64>

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Request Body schema: application/json

objectId	integer <int64> ID assigned to an object accessed using the credential set.
propagate	boolean Indicates whether child objects are accessed using the same credential set.
guest	string Guest OS type. Enum: "GuestWindows" "GuestLinux"
	object or null Guest OS settings.

Responses

200

Success

403

Forbidden

post/api/v2.3/credentials/{credentialId}/assign/guest

Request samples

Payload
curl

application/json

{"objectId": 2048,
"propagate": true,
"guest": "GuestLinux",
"guestSettings": {"sshPort": 22,
"sshSkipVerification": false,
"propagate": true
}
}

Response samples

application/json

{"credentialId": 15,
"userName": "root",
"assignedObjects": [{"objectId": 2048,
"objectName": "linux-web01.tech.local",
"objectType": "VwVm",
"guestAssign": "GuestLinux",
"settingsInfo": {"sshPort": 22,
"sshSkipVerification": false
}
}
]
}

Get ServiceNow Credentials

Returns a resource representation of the ServiceNow credentials.

SecurityBearer

Responses

200

Success

403

Forbidden

get/api/v2.3/credentials/assign/servicenow

Request samples

curl

Response samples

application/json

{"credentialId": 18,
"userName": "svc-servicenow",
"assignedObjects": [{"objectId": 3072,
"objectName": "ServiceNow Instance",
"objectType": "ServiceNow",
"guestAssign": "GuestWindows",
"settingsInfo": null
}
]
}

Delete Credentials

Deletes an unassigned credential set with the specified ID.

SecurityBearer

Request

path Parameters

credentialId

required

integer <int64>

Responses

200

Success

403

Forbidden

delete/api/v2.3/credentials/{credentialId}

Request samples

curl

Response samples

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Patch Credentials

Modifies a credential set with the specified ID.

SecurityBearer

Request

path Parameters

credentialId

required

integer <int64>

Request Body schema: application/json

type required	string non-empty Default: "Password" Type of credentials.
userName	string or null [ 0 .. 100 ] characters User name.
password	string or null [ 0 .. 255 ] characters Password.
description	string or null [ 0 .. 1000 ] characters Description.
sshKey	string or null SSH key.
sshKeyPassword	string or null SSH key password.

Responses

200

Success

403

Forbidden

patch/api/v2.3/credentials/{credentialId}

Request samples

Payload
curl

application/json

{"type": "Password",
"userName": "TECH\\administrator",
"password": "P@ssw0rd!",
"description": "vCenter Server service account",
"sshKey": null,
"sshKeyPassword": null
}

Response samples

application/json

{"credentialsId": 12,
"type": "Password",
"userName": "TECH\\administrator",
"description": "vCenter Server service account",
"lastModified": "2026-01-15T10:24:33Z",
"currentlyAssigned": true,
"isPropagated": false
}

Get Credentials Assigned to Object

Returns a resource representation of credential set that is used to access an object with the specified ID.

SecurityBearer

Request

path Parameters

objectId

required

integer <int64>

Responses

200

Success

403

Forbidden

get/api/v2.3/credentials/object/{objectId}

Request samples

curl

Response samples

application/json

[{"credentialsId": 12,
"type": "Password",
"userName": "TECH\\administrator",
"description": "vCenter Server service account",
"lastModified": "2026-01-15T10:24:33Z",
"currentlyAssigned": true,
"isPropagated": false,
"assignType": "Ordinary"
},
{"credentialsId": 15,
"type": "SshKey",
"userName": "root",
"description": "Linux guest OS access",
"lastModified": "2026-01-12T08:15:00Z",
"currentlyAssigned": true,
"isPropagated": true,
"assignType": "GuestLinux"
}
]

Delete Credentials Assigned to Object

Deletes credential set that is used to access an object with the specified ID.

SecurityBearer

Request

path Parameters

objectId

required

integer <int64>

query Parameters

propagate

boolean

Responses

200

Success

403

Forbidden

delete/api/v2.3/credentials/object/{objectId}

Request samples

curl

Response samples

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}