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 Role API

The Role API from Datadog — 8 operation(s) for role.

Datadog Role 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 Role. 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 15 operations across 8 paths, and defines 50 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}.

15 operations 8 paths 50 schemas 4 DELETE4 GET1 PATCH6 POST

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 Role 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 15

Across 8 paths, the API surfaces 15 operations — 4 DELETE, 4 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Role 15
DELETE
/api/v2/logs/config/archives/{archive_id}/readers
Datadog Revoke Role from an Archive
RemoveRoleFromArchive 1 param body → 204400403404429
POST
/api/v2/logs/config/archives/{archive_id}/readers
Datadog Grant Role to an Archive
AddReadRoleToArchive 1 param body → 204400403404429
GET
/api/v2/logs/config/restriction_queries/role/{role_id}
Datadog Get Restriction Query for a Given Role
GetRoleRestrictionQuery 1 param → 200400403429
DELETE
/api/v2/logs/config/restriction_queries/{restriction_query_id}/roles
Datadog Revoke Role from a Restriction Query
RemoveRoleFromRestrictionQuery 1 param body → 204400403404429
POST
/api/v2/logs/config/restriction_queries/{restriction_query_id}/roles
Datadog Grant Role to a Restriction Query
AddRoleToRestrictionQuery 1 param body → 204400403404429
POST
/api/v2/roles
Datadog Create Role
CreateRole body → 200400403429
DELETE
/api/v2/roles/{role_id}
Datadog Delete Role
DeleteRole 1 param → 204403404429
GET
/api/v2/roles/{role_id}
Datadog Get a Role
GetRole 1 param → 200403404429
PATCH
/api/v2/roles/{role_id}
Datadog Update a Role
UpdateRole 1 param body → 200400403404422429
POST
/api/v2/roles/{role_id}/clone
Datadog Create a New Role by Cloning an Existing Role
CloneRole 1 param body → 200400403404409429
GET
/api/v2/roles/{role_id}/permissions
Datadog List Permissions for a Role
ListRolePermissions 1 param → 200403404429
POST
/api/v2/roles/{role_id}/permissions
Datadog Grant Permission to a Role
AddPermissionToRole 1 param body → 200400403404429
DELETE
/api/v2/roles/{role_id}/users
Datadog Remove a User from a Role
RemoveUserFromRole 1 param body → 200400403404429
GET
/api/v2/roles/{role_id}/users
Datadog Get All Users of a Role
ListRoleUsers 5 params → 200403404429
POST
/api/v2/roles/{role_id}/users
Datadog Add a User to a Role
AddUserToRole 1 param body → 200400403404429

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are UserAttributes (12 properties), OrganizationAttributes (8 properties), PermissionAttributes (7 properties), RoleCreateResponseData (4 properties). Each schema is shown below with its type and property counts.

RoleUpdateData
object
Data related to the update of a role.
4 properties 3 required
RelationshipToUserData
object
Relationship to user object.
2 properties 2 required
RestrictionQueryWithoutRelationships
object
Restriction query object returned by the API.
3 properties
RoleCreateRequest
object
Create a role.
1 property 1 required
UsersType
string
Users resource type.
RelationshipToPermission
object
Relationship to a permissions object.
1 property
PermissionsType
string
Permissions resource type.
RoleUpdateRequest
object
Update a role.
1 property 1 required
RestrictionQueryAttributes
object
Attributes of the restriction query.
3 properties
RelationshipToRoles
object
Relationship to roles.
1 property
UsersResponse
object
Response containing information about multiple users.
3 properties
OrganizationAttributes
object
Attributes of the organization.
8 properties
APIErrorResponse
object
API error response.
1 property 1 required
RelationshipToRole
object
Relationship to role.
1 property
UserResponseRelationships
object
Relationships of the user object returned by the API.
4 properties
RelationshipToOrganizations
object
Relationship to organizations.
1 property 1 required
UserAttributes
object
Attributes of user object returned by the API.
12 properties
RoleRelationships
object
Relationships of the role object.
1 property
RoleCreateData
object
Data related to the creation of a role.
3 properties 1 required
RoleUpdateResponse
object
Response containing information about an updated role.
1 property
RoleCreateAttributes
object
Attributes of the created role.
3 properties 1 required
Pagination
object
Pagination object.
2 properties
PermissionAttributes
object
Attributes of a permission.
7 properties
RoleUpdateResponseData
object
Role object returned by the API.
4 properties 1 required
RoleResponseRelationships
object
Relationships of the role object returned by the API.
1 property
RestrictionQueryListResponse
object
Response containing information about multiple restriction queries.
1 property
RoleCreateResponseData
object
Role object returned by the API.
4 properties 1 required
RoleCloneAttributes
object
Attributes required to create a new role by cloning an existing one.
1 property 1 required
PermissionsResponse
object
Payload with API-returned permissions.
1 property
UserResponseIncludedItem
An object related to a user.
RoleAttributes
object
Attributes of the role.
4 properties
RoleUpdateAttributes
object
Attributes of the role.
4 properties
RoleCloneRequest
object
Request to create a role by cloning an existing role.
1 property 1 required
RoleClone
object
Data for the clone role request.
2 properties 2 required
Permission
object
Permission object.
3 properties 1 required
RoleCreateResponse
object
Response containing information about a created role.
1 property
RelationshipToRoleData
object
Relationship to role object.
2 properties
RoleResponse
object
Response containing information about a single role.
1 property
ResponseMetaAttributes
object
Object describing meta attributes of response.
1 property
User
object
User object returned by the API.
4 properties
RelationshipToOrganizationData
object
Relationship to organization object.
2 properties 2 required
Organization
object
Organization object.
3 properties 1 required
RelationshipToUser
object
Relationship to user.
1 property 1 required
Role
object
Role object returned by the API.
4 properties 1 required
RolesType
string
Roles type.
OrganizationsType
string
Organizations resource type.
RelationshipToUsers
object
Relationship to users.
1 property 1 required
RelationshipToPermissions
object
Relationship to multiple permissions objects.
1 property
RelationshipToOrganization
object
Relationship to an organization.
1 property 1 required
RelationshipToPermissionData
object
Relationship to permission object.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datadog-role-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 Roles API
Datadog Key Management API
Datadog Organizations API
Datadog Downtimes API
Datadog RUM API
Where this information came from

This is an independent, third-party profile of Datadog Role 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.