Retrieves agents for the Knowledge Tier tenant
- 22 Nov 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Retrieves agents for the Knowledge Tier tenant
- Updated on 22 Nov 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/v3/agents
Security
HTTP
Type basic
Basic Authentication
Query parameters
cursor
string
Pagination parameter—When present, the dataset returned is a portion of the requested data. Use this value and provide it as a query parameter cursor to retrieve the following records.
ExampleexysG404av_4oun13==
Responses
200
A category organizes assets into meaningful groups that can offer insight to users, improve accessibility, and streamline workflow. Refer to Categories for more information.
Headers
X-RateLimit-Limit
integer
Number of calls allowed within a time-bound window before rate limiting begins
X-RateLimit-Remaining
integer
Number of calls remaining in the rate limit window
X-RateLimit-Reset
integer
Time at which the current rate limit window resets in UTC epoch seconds
object
data
Array of object (agent)
object
id
string
This id is the global identifier (e.g. agt_huipDFHzh9t7ERxx4aWYUv8zYNiZ4) that references an agent/connector.
Exampleagt_huipDFHzh9t7ERxx4aWYUv8zYNiZ4
name
string
The friendly name of the agent/connector as displayed in the UI
ExampleSQL Server Agent
version
string
the software version of the installed agent
Example0.1.3
created_by
string
The global identifier (pcp_gxotXGFxx8p5JB5KCc3bUHBqw=) that references users acting on the resource
Examplepcp_gxotXGFxx8p5JB5KCc3bUHBqw=
created_on
string (date-time)
Date that the resource was created
modified_by
string
This id is the global identifier (e.g. pcp_gxotXGFxh8p5JB5KCc3bUHBqw=) that represents the user that last modified the asset. This value is omitted for new assets since they haven't been modified yet.
Examplepcp_gxotXGFxh8p5JB5KCc3bUHBqw=
modified_on
string (date-time)
Date asset was modified; this field is omitted for new assets.
cursor
string
Pagination parameter—If present, the dataset returned is a portion of the requested data. Use this value and provide it as a query parameter cursor to retrieve the following records.
ExampleexysG404av_4oun13==
401
Authentication information is missing or invalid.
Headers
WWW-Authenticate
string
429
There were too many requests, so rate limiting is in effect.
Headers
X-RateLimit-Limit
integer
Number of calls allowed within a time-bound window before rate limiting begins
X-RateLimit-Remaining
integer
Number of calls remaining in the rate limit window
X-RateLimit-Reset
integer
Time at which the current rate limit window resets in UTC epoch seconds
