openapi: 3.0.0
info:
contact:
email: support@datadoghq.com
name: Datadog Support
url: https://www.datadoghq.com/support/
description: The Datadog API is an HTTP REST API. The API uses resource-oriented URLs to call the API, uses status codes to indicate the success or failure of requests, returns JSON from all requests, and uses standard HTTP response codes. Use the Datadog API to access the Datadog platform programmatically.
title: Datadog Account Roles API
version: '1.0'
servers:
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: The regional site for Datadog customers.
enum:
- datadoghq.com
- us3.datadoghq.com
- us5.datadoghq.com
- ap1.datadoghq.com
- datadoghq.eu
- ddog-gov.com
subdomain:
default: api
description: The subdomain where the API is deployed.
- url: '{protocol}://{name}'
variables:
name:
default: api.datadoghq.com
description: Full site DNS name.
protocol:
default: https
description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: Any Datadog deployment.
subdomain:
default: api
description: The subdomain where the API is deployed.
security:
- apiKeyAuth: []
appKeyAuth: []
tags:
- description: '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 roles
in the Datadog application without using this API. For example, granting
read access on a specific log index to a role can be done in Datadog from the
[Pipelines page](https://app.datadoghq.com/logs/pipelines).'
name: Roles
paths:
/api/v2/logs/config/archives/{archive_id}/readers:
get:
description: Returns all read roles a given archive is restricted to.
operationId: ListArchiveReadRoles
parameters:
- $ref: '#/components/parameters/ArchiveID'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RolesResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog List Read Roles for an Archive
tags:
- Roles
x-codegen-request-body-name: body
x-menu-order: 6
x-permission:
operator: OR
permissions:
- logs_read_config
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/logs/config/restriction_queries/{restriction_query_id}/roles:
get:
description: Returns all roles that have a given restriction query.
operationId: ListRestrictionQueryRoles
parameters:
- $ref: '#/components/parameters/RestrictionQueryID'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RestrictionQueryRolesResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog List Roles for a Restriction Query
tags:
- Roles
x-codegen-request-body-name: body
x-menu-order: 6
x-permission:
operator: OR
permissions:
- logs_read_config
x-undo:
type: safe
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/roles:
get:
description: Returns all roles, including their names and their unique identifiers.
operationId: ListRoles
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- description: 'Sort roles depending on the given field. Sort order is **ascending** by default.
Sort order is **descending** if the field is prefixed by a negative sign, for example:
`sort=-name`.'
in: query
name: sort
required: false
schema:
$ref: '#/components/schemas/RolesSort'
example: example_value
- description: Filter all roles by the given string.
in: query
name: filter
required: false
schema:
type: string
example: example_value
- description: Filter all roles by the given list of role IDs.
in: query
name: filter[id]
required: false
schema:
type: string
example: abc-123-def
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RolesResponse'
description: OK
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- user_access_read
summary: Datadog List Roles
tags:
- Roles
x-menu-order: 1
x-permission:
operator: OR
permissions:
- user_access_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
parameters:
PageSize:
description: Size for a given page. The maximum allowed value is 100.
in: query
name: page[size]
required: false
schema:
default: 10
example: 10
format: int64
type: integer
ArchiveID:
description: The ID of the archive.
in: path
name: archive_id
required: true
schema:
type: string
PageNumber:
description: Specific page number to return.
in: query
name: page[number]
required: false
schema:
default: 0
example: 0
format: int64
type: integer
RestrictionQueryID:
description: The ID of the restriction query.
in: path
name: restriction_query_id
required: true
schema:
type: string
schemas:
PermissionsType:
default: permissions
description: Permissions resource type.
enum:
- permissions
example: permissions
type: string
x-enum-varnames:
- PERMISSIONS
RestrictionQueryRole:
description: Partial role object.
properties:
attributes:
$ref: '#/components/schemas/RestrictionQueryRoleAttribute'
id:
description: ID of the role.
example: <ROLE_ID>
type: string
type:
default: roles
description: Role resource type.
example: roles
readOnly: true
type: string
type: object
RestrictionQueryRoleAttribute:
description: Attributes of the role for a restriction query.
properties:
name:
description: The role name.
example: Datadog Admin Role
type: string
type: object
APIErrorResponse:
description: API error response.
properties:
errors:
description: A list of errors.
example:
- Bad Request
items:
description: A list of items.
example: Bad Request
type: string
type: array
required:
- errors
type: object
Pagination:
description: Pagination object.
properties:
total_count:
description: Total count.
format: int64
type: integer
example: 42
total_filtered_count:
description: Total count of elements matched by the filter.
format: int64
type: integer
example: 42
type: object
RoleResponseRelationships:
description: Relationships of the role object returned by the API.
properties:
permissions:
$ref: '#/components/schemas/RelationshipToPermissions'
type: object
RestrictionQueryRolesResponse:
description: Response containing information about roles attached to a restriction query.
properties:
data:
description: Array of roles.
items:
$ref: '#/components/schemas/RestrictionQueryRole'
type: array
type: object
RoleAttributes:
description: Attributes of the role.
properties:
created_at:
description: Creation time of the role.
format: date-time
readOnly: true
type: string
example: example_value
modified_at:
description: Time of last role modification.
format: date-time
readOnly: true
type: string
example: example_value
name:
description: The name of the role. The name is neither unique nor a stable identifier of the role.
type: string
example: Example Monitor
user_count:
description: Number of users with that role.
format: int64
readOnly: true
type: integer
example: 42
type: object
RolesResponse:
description: Response containing information about multiple roles.
properties:
data:
description: Array of returned roles.
items:
$ref: '#/components/schemas/Role'
type: array
meta:
$ref: '#/components/schemas/ResponseMetaAttributes'
type: object
ResponseMetaAttributes:
description: Object describing meta attributes of response.
properties:
page:
$ref: '#/components/schemas/Pagination'
type: object
x-merge-override:
properties: false
RolesSort:
default: name
description: Sorting options for roles.
enum:
- name
- -name
- modified_at
- -modified_at
- user_count
- -user_count
type: string
x-enum-varnames:
- NAME_ASCENDING
- NAME_DESCENDING
- MODIFIED_AT_ASCENDING
- MODIFIED_AT_DESCENDING
- USER_COUNT_ASCENDING
- USER_COUNT_DESCENDING
Role:
description: Role object returned by the API.
properties:
attributes:
$ref: '#/components/schemas/RoleAttributes'
id:
description: The unique identifier of the role.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/RoleResponseRelationships'
type:
$ref: '#/components/schemas/RolesType'
required:
- type
type: object
x-merge-override:
required: false
RolesType:
default: roles
description: Roles type.
enum:
- roles
example: roles
type: string
x-enum-varnames:
- ROLES
RelationshipToPermissions:
description: Relationship to multiple permissions objects.
properties:
data:
description: Relationships to permission objects.
items:
$ref: '#/components/schemas/RelationshipToPermissionData'
type: array
type: object
x-merge-override:
required: false
RelationshipToPermissionData:
description: Relationship to permission object.
properties:
id:
description: ID of the permission.
type: string
example: abc-123-def
type:
$ref: '#/components/schemas/PermissionsType'
type: object
x-merge-override:
required: false
responses:
TooManyRequestsResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
securitySchemes:
AuthZ:
description: This API uses OAuth 2 with the implicit grant flow.
flows:
authorizationCode:
authorizationUrl: /oauth2/v1/authorize
scopes:
apm_api_catalog_read: View API catalog and API definitions.
apm_api_catalog_write: Add, modify, and delete API catalog definitions.
apm_read: Read and query APM and Trace Analytics.
apm_service_catalog_read: View service catalog and service definitions.
apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog.
appsec_vm_read: View infrastructure, application code, and library vulnerabilities. This does not restrict API or inventory SQL access to the vulnerability data source.
cases_read: View Cases.
cases_write: Create and update cases.
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API.
ci_visibility_read: View CI Visibility.
cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs.
cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs.
code_analysis_read: View Code Analysis.
continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO).
create_webhooks: Create webhooks integrations.
dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'.
dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'.
dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally.
dashboards_read: View dashboards.
dashboards_write: Create and change dashboards.
data_scanner_read: View Data Scanner configurations.
data_scanner_write: Edit Data Scanner configurations.
embeddable_graphs_share: Generate public links to share embeddable graphs externally.
events_read: Read Events data.
hosts_read: List hosts and their attributes.
incident_notification_settings_write: Configure Incidents Notification settings.
incident_read: View incidents in Datadog.
incident_settings_write: Configure Incident Settings.
incident_write: Create, view, and manage incidents in Datadog.
metrics_read: View custom metrics.
monitor_config_policy_write: Edit and delete monitor configuration.
monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes.
monitors_read: View monitors.
monitors_write: Edit, delete, and resolve individual monitors.
org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization.
security_comments_read: Read comments of vulnerabilities.
security_monitoring_filters_read: Read Security Filters.
security_monitoring_filters_write: Create, edit, and delete Security Filters.
security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks.
security_monitoring_notification_profiles_read: View Rule Security Notification rules.
security_monitoring_notification_profiles_write: Create, edit, and delete Security Notification rules.
security_monitoring_rules_read: Read Detection Rules.
security_monitoring_rules_write: Create and edit Detection Rules.
security_monitoring_signals_read: View Security Signals.
security_monitoring_suppressions_read: Read Rule Suppressions.
security_monitoring_suppressions_write: Write Rule Suppressions.
security_pipelines_read: View Security Pipelines.
security_pipelines_write: Create, edit, and delete CSM Security Pipelines.
slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs.
slos_read: View SLOs and status corrections.
slos_write: Create, edit, and delete SLOs.
synthetics_global_variable_read: View, search, and use Synthetics global variables.
synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics.
synthetics_private_location_read: View, search, and use Synthetics private locations.
synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines.
synthetics_read: List and view configured Synthetic tests and test results.
synthetics_write: Create, edit, and delete Synthetic tests.
teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission.
teams_read: Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team.
test_optimization_read: View Test Optimization.
timeseries_query: Query Timeseries data.
usage_read: View your organization's usage and usage attribution.
user_access_invite: Invite other users to your organization.
user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries.
user_access_read: View users and their roles and settings.
workflows_read: View workflows.
workflows_run: Run workflows.
workflows_write: Create, edit, and delete workflows.
tokenUrl: /oauth2/v1/token
type: oauth2
apiKeyAuth:
description: Your Datadog API Key.
in: header
name: DD-API-KEY
type: apiKey
x-env-name: DD_API_KEY
appKeyAuth:
description: Your Datadog APP Key.
in: header
name: DD-APPLICATION-KEY
type: apiKey
x-env-name: DD_APP_KEY
bearerAuth:
scheme: bearer
type: http
x-env-name: DD_BEARER_TOKEN
x-group-parameters: true
x-merge-override:
paths: false