Delegate API Post Call to List All Child Scope for Delegate Status
in progress
R
Rubber Scallop
API Call for All Child Scope for Delegate Status
We have been using this API to get the status of our delegates. However, the current setup of the API calls, only allows us to pull the status of the delegates one by one.
Requesting a post call to get the list of all child scope with one call so we can integrate with Dynatrace Synthetic monitoring.
Log In
Prateek Mittal
Hi Rubber Scallop
Below is the proposed format of API output which list all the delegates inside an account including child scopes. With the below format, you can filter the delegates on Org name, Project Name as well.
Can you please review this.
{
"delegates": [
{
"delegateName": "Delegate 1",
"status": "CONNECTED",
"description": "Account level delegate",
"hostName": "host-1",
"delegateType": "Kubernetes",
"delegateGroupIdentifier": "group-1",
"delegateTags": ["tag1", "tag2"],
"delegateInstanceFilter": "ACTIVE",
"tags": {
"property1": "value1",
"property2": "value2"
},
"filterType": "Connector"
},
{
"delegateName": "Delegate 2",
"status": "CONNECTED",
"description": "Delegate in Org1",
"hostName": "host-2",
"delegateType": "VM",
"delegateGroupIdentifier": "group-2",
"delegateTags": ["tag3"],
"delegateInstanceFilter": "ACTIVE",
"tags": {
"property3": "value3",
"property4": "value4"
},
"filterType": "Custom",
"orgName": "Org1"
},
{
"delegateName": "Delegate 3",
"status": "CONNECTED",
"description": "Delegate in Proj1 of Org1",
"hostName": "host-3",
"delegateType": "Cloud",
"delegateGroupIdentifier": "group-3",
"delegateTags": ["tag4", "tag5"],
"delegateInstanceFilter": "ACTIVE",
"tags": {
"property5": "value5",
"property6": "value6"
},
"filterType": "Connector",
"orgName": "Org1",
"projName": "Proj1"
}
]
}
R
Rubber Scallop
Prateek Mittal From one of my leads/directors - What role does the API token require to see all child scopes? His current account read-only role only returns the account level delegate status.
R
Rubber Scallop
Hi Prateek Mittal - may we know what role the API token requires to see all the child scopes?
Prateek Mittal
Rubber Scallop: If the user has role access to see the lower scopes such as org and projects. They can access the delegates. The role will be view access on delegates in the lower scopes.
Prateek Mittal
in progress
Prateek Mittal
Hi Rubber Scallop
Below is the proposed format of API output which list all the delegates inside an account including child scopes. With the below format, you can filter the delegates on Org name, Project Name as well.
Can you please review this.
{
"delegates": [
{
"delegateName": "Delegate 1",
"status": "CONNECTED",
"description": "Account level delegate",
"hostName": "host-1",
"delegateType": "Kubernetes",
"delegateGroupIdentifier": "group-1",
"delegateTags": ["tag1", "tag2"],
"delegateInstanceFilter": "ACTIVE",
"tags": {
"property1": "value1",
"property2": "value2"
},
"filterType": "Connector"
},
{
"delegateName": "Delegate 2",
"status": "CONNECTED",
"description": "Delegate in Org1",
"hostName": "host-2",
"delegateType": "VM",
"delegateGroupIdentifier": "group-2",
"delegateTags": ["tag3"],
"delegateInstanceFilter": "ACTIVE",
"tags": {
"property3": "value3",
"property4": "value4"
},
"filterType": "Custom",
"orgName": "Org1"
},
{
"delegateName": "Delegate 3",
"status": "CONNECTED",
"description": "Delegate in Proj1 of Org1",
"hostName": "host-3",
"delegateType": "Cloud",
"delegateGroupIdentifier": "group-3",
"delegateTags": ["tag4", "tag5"],
"delegateInstanceFilter": "ACTIVE",
"tags": {
"property5": "value5",
"property6": "value6"
},
"filterType": "Connector",
"orgName": "Org1",
"projName": "Proj1"
}
]
}
Prateek Mittal
next fiscal quarter
Prateek Mittal
The above scenario can be achieved by using the Account Identifier as the filter in the below API which should list the set of delegates at the account level -
R
Rubber Scallop
Prateek Mittal Hi,
With only account id, we only get account level delegates.
To grab all delegates, at all levels, we need to write custom code to loop through all org and project and call the API and consolidate the result.
So this request is to have an API where we can get all the delegates, at all levels, without having to loop through all or orgs and projects.
At the moment, we have to run a script to get the list of all delegates.
Please let me know if it does not make sense and can get on a call.
Prateek Mittal
Rubber Scallop: That makes sense. I will create an internal ticket to track this request. We can provide a single API where if an Admin has access then by querying this API, it will list all the delegates in that account.
Prateek Mittal
under review