> ## Documentation Index > Fetch the complete documentation index at: https://docs.rootly.com/llms.txt > Use this file to discover all available pages before exploring further. # Creates an alert > Creates a new alert from provided data ## OpenAPI ````yaml https://rootly-heroku.s3.amazonaws.com/swagger/v1/swagger.json post /v1/alerts openapi: 3.0.1 info: title: Rootly API v1 version: v1 description: >+ # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \ --header 'Content-Type: application/vnd.api+json' \ --header 'Authorization: Bearer YOUR-TOKEN' \ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{"error": "Rate limit exceeded. Try again later."}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., "1000, 1000;window=3600" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \ --header 'Content-Type: application/vnd.api+json' \ --header 'Authorization: Bearer YOUR-TOKEN' \ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ``` x-logo: url: https://rootly-heroku.s3.us-east-1.amazonaws.com/swagger/v1/logo.png servers: - url: https://api.rootly.com security: [] paths: /v1/alerts: post: tags: - Alerts summary: Creates an alert description: Creates a new alert from provided data operationId: createAlert parameters: [] requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/new_alert' required: true responses: '201': description: alert created content: application/vnd.api+json: schema: $ref: '#/components/schemas/alert_response' '401': description: resource not found content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_list' '422': description: invalid request content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_list' security: - bearer_auth: [] components: schemas: new_alert: type: object properties: data: type: object properties: type: type: string enum: - alerts attributes: type: object properties: noise: type: string description: Whether the alert is marked as noise enum: - noise - not_noise nullable: true source: type: string description: The source of the alert enum: - rootly - manual - api - heartbeat - web - slack - email - workflow - live_call_routing - mobile - pagerduty - opsgenie - victorops - pagertree - datadog - dynatrace - nobl9 - zendesk - asana - clickup - sentry - rollbar - jira - honeycomb - service_now - linear - grafana - alertmanager - google_cloud - generic_webhook - cloud_watch - aws_sns - azure - splunk - chronosphere - app_optics - bug_snag - monte_carlo - nagios - prtg - catchpoint - app_dynamics - checkly - new_relic - gitlab status: type: string enum: - open - triggered description: >- Only available for organizations with Rootly On-Call enabled. Can be one of open, triggered. summary: type: string description: The summary of the alert description: type: string description: The description of the alert nullable: true service_ids: type: array description: >- The Service IDs to attach to the alert. If your organization has On-Call enabled and your notification target is a Service. This field will be automatically set for you. items: type: string nullable: true group_ids: type: array description: >- The Group IDs to attach to the alert. If your organization has On-Call enabled and your notification target is a Group. This field will be automatically set for you. items: type: string nullable: true environment_ids: type: array description: The Environment IDs to attach to the alert items: type: string nullable: true started_at: type: string description: Alert start datetime format: date-time nullable: true ended_at: type: string description: Alert end datetime format: date-time nullable: true external_id: type: string description: External ID nullable: true external_url: type: string description: External Url nullable: true alert_urgency_id: type: string description: The ID of the alert urgency nullable: true notification_target_type: type: string enum: - User - Group - EscalationPolicy - Service - Functionality description: >- Only available for organizations with Rootly On-Call enabled. Can be one of Group, Service, EscalationPolicy, Functionality, User. Please contact support if you encounter issues using `Functionality` as a notification target type. nullable: true notification_target_id: type: string description: >- Only available for organizations with Rootly On-Call enabled. The _identifier_ of the notification target object. nullable: true labels: type: array items: type: object properties: key: type: string description: Key of the tag value: oneOf: - type: string - type: number - type: boolean description: Value of the tag required: - key - value nullable: true data: type: object description: Additional data nullable: true deduplication_key: type: string description: >- Alerts sharing the same deduplication key are treated as a single alert. nullable: true alert_field_values_attributes: type: array description: Custom alert field values to create with the alert items: type: object properties: alert_field_id: type: string description: ID of the custom alert field value: type: string description: Value for the alert field required: - alert_field_id - value nullable: true additionalProperties: false required: - source - summary required: - type - attributes required: - data alert_response: type: object properties: data: type: object properties: id: type: string description: Unique ID of the alert source: type: string description: The source of the alert enum: - rootly - manual - api - heartbeat - web - slack - email - workflow - live_call_routing - mobile - pagerduty - opsgenie - victorops - pagertree - datadog - dynatrace - nobl9 - zendesk - asana - clickup - sentry - rollbar - jira - honeycomb - service_now - linear - grafana - alertmanager - google_cloud - generic_webhook - cloud_watch - aws_sns - azure - splunk - chronosphere - app_optics - bug_snag - monte_carlo - nagios - prtg - catchpoint - app_dynamics - checkly - new_relic - gitlab type: type: string enum: - alerts attributes: type: object allOf: - $ref: '#/components/schemas/alert' required: - id - type - attributes required: - data errors_list: type: object properties: errors: type: array items: type: object properties: title: type: string status: type: string code: type: string nullable: true detail: type: string nullable: true required: - title - status alert: type: object properties: short_id: type: string description: Human-readable short identifier for the alert noise: type: string description: Whether the alert is marked as noise enum: - noise - not_noise nullable: true source: type: string description: The source of the alert enum: - rootly - manual - api - heartbeat - web - slack - email - workflow - live_call_routing - mobile - pagerduty - opsgenie - victorops - pagertree - datadog - dynatrace - nobl9 - zendesk - asana - clickup - sentry - rollbar - jira - honeycomb - service_now - linear - grafana - alertmanager - google_cloud - generic_webhook - cloud_watch - aws_sns - azure - splunk - chronosphere - app_optics - bug_snag - monte_carlo - nagios - prtg - catchpoint - app_dynamics - checkly - new_relic - gitlab status: type: string enum: - open - triggered - acknowledged - resolved - deferred description: The status of the alert summary: type: string description: The summary of the alert description: type: string description: The description of the alert nullable: true services: type: array description: Services attached to the alert items: type: object allOf: - $ref: '#/components/schemas/service' groups: type: array description: Groups attached to the alert items: type: object allOf: - $ref: '#/components/schemas/team' environments: type: array description: Environments attached to the alert items: type: object allOf: - $ref: '#/components/schemas/environment' service_ids: type: array description: >- The Service IDs to attach to the alert. If your organization has On-Call enabled and your notification target is a Service. This field will be automatically set for you. items: type: string nullable: true group_ids: type: array description: >- The Group IDs to attach to the alert. If your organization has On-Call enabled and your notification target is a Group. This field will be automatically set for you. items: type: string nullable: true environment_ids: type: array description: The Environment IDs to attach to the alert items: type: string nullable: true external_id: type: string description: External ID nullable: true external_url: type: string description: External Url nullable: true alert_urgency_id: type: string description: The ID of the alert urgency nullable: true group_leader_alert_id: type: string description: The ID of the group leader alert nullable: true is_group_leader_alert: type: boolean description: Whether the alert is a group leader alert nullable: true labels: type: array items: type: object properties: key: type: string description: Key of the tag value: oneOf: - type: string - type: number - type: boolean description: Value of the tag required: - key - value nullable: true data: type: object description: Additional data nullable: true deduplication_key: type: string description: >- Alerts sharing the same deduplication key are treated as a single alert. nullable: true alert_field_values_attributes: type: array description: Custom alert field values to create with the alert items: type: object properties: alert_field_id: type: string description: ID of the custom alert field value: type: string description: Value for the alert field required: - alert_field_id - value nullable: true started_at: type: string description: When the alert started format: date-time nullable: true ended_at: type: string description: When the alert ended format: date-time nullable: true created_at: type: string description: Date of creation updated_at: type: string description: Date of last update required: - short_id - source - summary - created_at - updated_at service: type: object properties: name: type: string description: The name of the service slug: type: string description: The slug of the service description: type: string description: The description of the service nullable: true public_description: type: string description: The public description of the service nullable: true notify_emails: type: array description: Emails attached to the service items: type: string nullable: true color: type: string description: The hex color of the service nullable: true position: type: integer description: Position of the service nullable: true backstage_id: type: string description: >- The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name nullable: true external_id: type: string description: The external id associated to this service nullable: true pagerduty_id: type: string description: The PagerDuty service id associated to this service nullable: true opsgenie_id: type: string description: The Opsgenie service id associated to this service nullable: true cortex_id: type: string description: The Cortex group id associated to this service nullable: true service_now_ci_sys_id: type: string description: The Service Now CI sys id associated to this service nullable: true github_repository_name: type: string description: >- The GitHub repository name associated to this service. eg: rootlyhq/my-service nullable: true github_repository_branch: type: string description: 'The GitHub repository branch associated to this service. eg: main' nullable: true gitlab_repository_name: type: string description: >- The GitLab repository name associated to this service. eg: rootlyhq/my-service nullable: true gitlab_repository_branch: type: string description: 'The GitLab repository branch associated to this service. eg: main' nullable: true kubernetes_deployment_name: type: string description: >- The Kubernetes deployment name associated to this service. eg: namespace/deployment-name nullable: true environment_ids: type: array description: Environments associated with this service items: type: string nullable: true service_ids: type: array description: Services dependent on this service items: type: string nullable: true owner_group_ids: type: array description: Owner Teams associated with this service items: type: string nullable: true owner_user_ids: type: array description: Owner Users associated with this service items: type: integer nullable: true alert_urgency_id: type: string description: The alert urgency id of the service nullable: true escalation_policy_id: type: string description: The escalation policy id of the service nullable: true alerts_email_enabled: type: boolean description: Enable alerts through email nullable: true alerts_email_address: type: string description: Email generated to send alerts to nullable: true slack_channels: type: array description: Slack Channels associated with this service items: type: object properties: id: type: string description: Slack channel ID name: type: string description: Slack channel name required: - id - name nullable: true slack_aliases: type: array description: Slack Aliases associated with this service items: type: object properties: id: type: string description: Slack alias ID name: type: string description: Slack alias name required: - id - name nullable: true alert_broadcast_enabled: type: boolean description: Enable alerts to be broadcasted to a specific channel nullable: true alert_broadcast_channel: type: object description: Slack channel to broadcast alerts to properties: id: type: string description: Slack channel ID name: type: string description: Slack channel name nullable: true incident_broadcast_enabled: type: boolean description: Enable incidents to be broadcasted to a specific channel nullable: true incident_broadcast_channel: type: object description: Slack channel to broadcast incidents to properties: id: type: string description: Slack channel ID name: type: string description: Slack channel name nullable: true properties: type: array items: type: object description: Set a value for a catalog property properties: catalog_property_id: type: string description: Catalog property ID value: type: string description: The property value required: - catalog_property_id - value description: Array of property values for this service. nullable: true created_at: type: string description: Date of creation updated_at: type: string description: Date of last update required: - name - created_at - updated_at team: type: object properties: name: type: string description: The name of the team slug: type: string description: type: string description: The description of the team nullable: true notify_emails: type: array description: Emails to attach to the team items: type: string nullable: true color: type: string description: The hex color of the team nullable: true position: type: integer description: Position of the team nullable: true backstage_id: type: string description: >- The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name nullable: true external_id: type: string description: The external id associated to this team nullable: true pagerduty_id: type: string description: The PagerDuty group id associated to this team nullable: true pagerduty_service_id: type: string description: The PagerDuty service id associated to this team nullable: true opsgenie_id: type: string description: The Opsgenie group id associated to this team nullable: true victor_ops_id: type: string description: The VictorOps group id associated to this team nullable: true pagertree_id: type: string description: The PagerTree group id associated to this team nullable: true cortex_id: type: string description: The Cortex group id associated to this team nullable: true service_now_ci_sys_id: type: string description: The Service Now CI sys id associated to this team nullable: true user_ids: type: array description: The user ids of the members of this team. items: type: integer nullable: true admin_ids: type: array description: >- The user ids of the admins of this team. These users must also be present in user_ids attribute. items: type: integer nullable: true alerts_email_enabled: type: boolean description: Enable alerts through email nullable: true alerts_email_address: type: string description: Email generated to send alerts to nullable: true alert_urgency_id: type: string description: The alert urgency id of the team nullable: true slack_channels: type: array description: Slack Channels associated with this team items: type: object properties: id: type: string description: Slack channel ID name: type: string description: Slack channel name required: - id - name nullable: true slack_aliases: type: array description: Slack Aliases associated with this team items: type: object properties: id: type: string description: Slack alias ID name: type: string description: Slack alias name required: - id - name nullable: true alert_broadcast_enabled: type: boolean description: Enable alerts to be broadcasted to a specific channel nullable: true alert_broadcast_channel: type: object description: Slack channel to broadcast alerts to properties: id: type: string description: Slack channel ID name: type: string description: Slack channel name nullable: true incident_broadcast_enabled: type: boolean description: Enable incidents to be broadcasted to a specific channel nullable: true incident_broadcast_channel: type: object description: Slack channel to broadcast incidents to properties: id: type: string description: Slack channel ID name: type: string description: Slack channel name nullable: true auto_add_members_when_attached: type: boolean description: Auto add members to incident channel when team is attached nullable: true properties: type: array items: type: object description: Set a value for a catalog property properties: catalog_property_id: type: string description: Catalog property ID value: type: string description: The property value required: - catalog_property_id - value description: Array of property values for this team. nullable: true created_at: type: string description: Date of creation updated_at: type: string description: Date of last update required: - name - created_at - updated_at environment: type: object properties: name: type: string description: The name of the environment slug: type: string description: The slug of the environment description: type: string description: The description of the environment nullable: true notify_emails: type: array description: Emails attached to the environment items: type: string nullable: true color: type: string description: The hex color of the environment nullable: true position: type: integer description: Position of the environment nullable: true slack_channels: type: array description: Slack Channels associated with this environment items: type: object properties: id: type: string description: Slack channel ID name: type: string description: Slack channel name required: - id - name nullable: true slack_aliases: type: array description: Slack Aliases associated with this environment items: type: object properties: id: type: string description: Slack alias ID name: type: string description: Slack alias name required: - id - name nullable: true properties: type: array items: type: object description: Set a value for a catalog property properties: catalog_property_id: type: string description: Catalog property ID value: type: string description: The property value required: - catalog_property_id - value description: Array of property values for this environment. nullable: true created_at: type: string description: Date of creation updated_at: type: string description: Date of last update required: - name - created_at - updated_at securitySchemes: bearer_auth: type: http scheme: bearer ````