How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Datadog Roles API

The Roles API is used to create and manage Datadog roles, what[global permissions](https://docs.datadoghq.com/account_management/rbac/)they grant, and which users belong to them.Permissions related to specific account assets can be granted to rolesin the Datadog application without using this API. For example, grantingread access on a specific log index to a role can be done in Datadog from the[Pipelines page](https://app.datadoghq.com/logs/pipelines).

Datadog Roles API is one of 290 APIs that Datadog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 4 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.

3 operations 3 paths 15 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.datadoghq.com
Authentication
OAuth 2.0, API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Datadog Roles API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (AuthZ) using the authorizationCode flow, exposing 68 scopes. An API key is passed in the header as DD-API-KEY (apiKeyAuth). An API key is passed in the header as DD-APPLICATION-KEY (appKeyAuth). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • AuthZ — This API uses OAuth 2 with the implicit grant flow.
  • apiKeyAuth — Your Datadog API Key.
  • appKeyAuth — Your Datadog APP Key.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Roles 3

The Roles API is used to create and manage Datadog roles, what [global permissions](https://docs.datadoghq.com/accountmanagement/rbac/) they grant, and which users belong to them.…

GET
/api/v2/logs/config/archives/{archive_id}/readers
Datadog List Read Roles for an Archive
ListArchiveReadRoles 1 param → 200400403404429
GET
/api/v2/logs/config/restriction_queries/{restriction_query_id}/roles
Datadog List Roles for a Restriction Query
ListRestrictionQueryRoles 3 params → 200400403404429
GET
/api/v2/roles
Datadog List Roles
ListRoles 5 params → 200403429

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are RoleAttributes (4 properties), Role (4 properties), RestrictionQueryRole (3 properties), RolesResponse (2 properties). Each schema is shown below with its type and property counts.

PermissionsType
string
Permissions resource type.
RestrictionQueryRole
object
Partial role object.
3 properties
RestrictionQueryRoleAttribute
object
Attributes of the role for a restriction query.
1 property
APIErrorResponse
object
API error response.
1 property 1 required
Pagination
object
Pagination object.
2 properties
RoleResponseRelationships
object
Relationships of the role object returned by the API.
1 property
RestrictionQueryRolesResponse
object
Response containing information about roles attached to a restriction query.
1 property
RoleAttributes
object
Attributes of the role.
4 properties
RolesResponse
object
Response containing information about multiple roles.
2 properties
ResponseMetaAttributes
object
Object describing meta attributes of response.
1 property
RolesSort
string
Sorting options for roles.
Role
object
Role object returned by the API.
4 properties 1 required
RolesType
string
Roles type.
RelationshipToPermissions
object
Relationship to multiple permissions objects.
1 property
RelationshipToPermissionData
object
Relationship to permission object.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datadog-roles-api-openapi.yml Raw ↑

Other APIs Datadog publishes across the network.

Datadog Dashboards API
Datadog Synthetics API
Datadog Service Level Objectives API
Datadog Security Monitoring API
Datadog Service Definition API
Datadog Software Catalog API
Datadog Users API
Datadog Key Management API
Datadog Organizations API
Datadog Downtimes API
Datadog RUM API
Datadog APM Retention Filters API
Where this information came from

This is an independent, third-party profile of Datadog Roles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.