Enumerate Adapter Instances Using GET
If Adapter Kind is passed as parameter, the API returns only the instances of that Adapter Kind
Request
URI
GET
https://{api_host}/api/adapters
COPY
Query Parameters
string
adapterKindKey
Optional
If this parameter is specified, the API returns only instances of this Adapter Kind.
Responses
200
The adapter instances managed by the system.
Returns adapter-instances of type(s) application/json
{
"adapterInstancesInfoDto": [
{
"adapter-certificates": [
{
"certificateDetails": "string",
"expires": "string",
"issuedBy": "string",
"issuedTo": "string",
"thumbprint": "string"
}
],
"collectorGroupId": "string",
"collectorId": 0,
"credentialInstanceId": "string",
"description": "string",
"id": "string",
"lastCollected": "string",
"lastHeartbeat": "string",
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"messageFromAdapterInstance": "string",
"monitoringInterval": 0,
"monitoringIntervalMinutes": 0,
"monitoringIntervalSeconds": 0,
"numberOfMetricsCollected": 0,
"numberOfResourcesCollected": 0,
"resourceKey": {
"adapterKindKey": "string",
"extension": {
"anyObjects": [
{}
]
},
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"name": "string",
"resourceIdentifiers": [
{
"identifierType": {
"dataType": "string",
"extension": {
"anyObjects": [
{}
]
},
"isPartOfUniqueness": false,
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"name": "string"
},
"key": "string",
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"name": "string",
"uniquelyIdentifying": false,
"value": "string"
}
],
"resourceKindKey": "string"
}
}
]
}
404
No adapter instance is found with the specified identifier
Operation doesn't return any data structure
Adapters Operations
POST
Create Adapter Instance Using POST
DELETE
Delete Adapter Instance Using DELETE
GET
Enumerate Adapter Instances Using GET
GET
Get Adapter Instance Using GET
GET
Get Resources Of Adapter Instance Using GET
PUT
Mark Adapter Instance As Being Maintained Using PUT
PATCH
Patch Adapter Instance Using PATCH
PATCH
Patch Test Connection Using PATCH
PUT
Start Monitoring Resources Of Adapter Instance Using PUT
PUT
Stop Monitoring Resources Of Adapter Instance Using PUT
POST
Test Connection Using POST
DELETE
Unmark Adapter Instance As Being Maintained Using DELETE
PUT
Update Adapter Instance Using PUT