Example Request
**URL:** `https://api-public.bitdrift.io/bitdrift.public.unary.admin.v1.AdminService/CreateKey` See [calling the API](../api-guide/calling-the-api.md) for authentication and request details. ```json { "name": "Example key", "sdk_key": { "app_id_postfix": ".staging", "bundle_id_regex": "io.example.app" } } ```Example Response
```json { "key": { "created_at": "2024-01-15T09:30:00Z", "expires_at": "2024-01-15T09:30:00Z", "id": 123, "name": "Example key", "revoked": false, "sdk_key": { "app_id_postfix": ".staging", "bundle_id_regex": "io.example.app", "key": "ZXhhbXBsZS1zZGsta2V5LWJhc2U2NA==" } } } ``` ### DeleteConnector Deletes a connector by ID.Example Request
**URL:** `https://api-public.bitdrift.io/bitdrift.public.unary.admin.v1.AdminService/DeleteConnector` See [calling the API](../api-guide/calling-the-api.md) for authentication and request details. ```json { "name": "example-connector" } ```Example Response
```json {} ``` ### DeleteNotificationGroup Deletes a notification group for the organization.Example Request
**URL:** `https://api-public.bitdrift.io/bitdrift.public.unary.admin.v1.AdminService/DeleteNotificationGroup` See [calling the API](../api-guide/calling-the-api.md) for authentication and request details. ```json { "name": "engineering-oncall" } ```Example Response
```json {} ``` ### GetConnectors Lists all connectors for the organization.Example Request
**URL:** `https://api-public.bitdrift.io/bitdrift.public.unary.admin.v1.AdminService/GetConnectors` See [calling the API](../api-guide/calling-the-api.md) for authentication and request details. ```json {} ```Example Response
```json { "connectors": [ { "cloudwatch_connector_config": { "region": "us-east-1", "role_arn": "arn:aws:iam::123456789012:role/CloudWatchConnectorRole" }, "name": "example-connector" } ] } ``` ### GetKeys Lists the API and SDK keys available to the authenticated user.Example Request
**URL:** `https://api-public.bitdrift.io/bitdrift.public.unary.admin.v1.AdminService/GetKeys` See [calling the API](../api-guide/calling-the-api.md) for authentication and request details. ```json {} ```Example Response
```json { "keys": [ { "created_at": "2024-01-15T09:30:00Z", "expires_at": "2024-01-15T09:30:00Z", "id": 123, "name": "Example key", "revoked": false, "sdk_key": { "app_id_postfix": ".staging", "bundle_id_regex": "io.example.app", "key": "ZXhhbXBsZS1zZGsta2V5LWJhc2U2NA==" } } ] } ``` ### GetNotificationGroups Lists all notification groups for the organization.Example Request
**URL:** `https://api-public.bitdrift.io/bitdrift.public.unary.admin.v1.AdminService/GetNotificationGroups` See [calling the API](../api-guide/calling-the-api.md) for authentication and request details. ```json {} ```Example Response
```json { "notification_groups": [ { "created_at": "2024-01-15T09:30:00Z", "notification_group": { "datadog_notifications": [ { "api_base_url": "https://navy.oncall.datadoghq.com", "api_key": "datadog-api-key", "application_key": "datadog-application-key", "severity": "HIGH", "team_handle": "backend-oncall" } ], "email_addresses": [ "user@example.com" ], "name": "engineering-oncall", "pager_duty_notifications": [ { "routing_key": "pagerduty-routing-key", "severity": "CRITICAL" } ], "slack_channels": [ "#incident-response" ], "sns_topic_arns": [ "arn:aws:sns:us-east-1:123456789012:incident-notifications" ] }, "used_at": "2024-01-15T09:30:00Z" } ] } ``` ### RevokeKey Revokes an API key or SDK key by ID.Example Request
**URL:** `https://api-public.bitdrift.io/bitdrift.public.unary.admin.v1.AdminService/RevokeKey` See [calling the API](../api-guide/calling-the-api.md) for authentication and request details. ```json { "id": 123 } ```Example Response
```json {} ``` ### TestAlertNotification Sends a test alert notification to validate formatting and mentions.Example Request
**URL:** `https://api-public.bitdrift.io/bitdrift.public.unary.admin.v1.AdminService/TestAlertNotification` See [calling the API](../api-guide/calling-the-api.md) for authentication and request details. ```json { "custom_notification_text": "@oncall-team Please investigate immediately.", "notification_group_names": [ "engineering-oncall" ], "workflow_alert": { "workflow_id": "checkout-errors" } } ```Example Response
```json { "errors": [ "PagerDuty returned an authentication error" ] } ``` ### TestNotificationGroup Sends a test notification to all targets in a notification group.Example Request
**URL:** `https://api-public.bitdrift.io/bitdrift.public.unary.admin.v1.AdminService/TestNotificationGroup` See [calling the API](../api-guide/calling-the-api.md) for authentication and request details. ```json { "name": "engineering-oncall" } ```Example Response
```json { "errors": [ "Slack channel not found" ] } ``` ### UpsertConnector Creates or updates a connector for the organization.Example Request
**URL:** `https://api-public.bitdrift.io/bitdrift.public.unary.admin.v1.AdminService/UpsertConnector` See [calling the API](../api-guide/calling-the-api.md) for authentication and request details. ```json { "connector": { "cloudwatch_connector_config": { "region": "us-east-1", "role_arn": "arn:aws:iam::123456789012:role/CloudWatchConnectorRole" }, "name": "example-connector" } } ```Example Response
```json {} ``` ### UpsertNotificationGroup Creates or updates a notification group for the organization.Example Request
**URL:** `https://api-public.bitdrift.io/bitdrift.public.unary.admin.v1.AdminService/UpsertNotificationGroup` See [calling the API](../api-guide/calling-the-api.md) for authentication and request details. ```json { "notification_group": { "datadog_notifications": [ { "api_base_url": "https://navy.oncall.datadoghq.com", "api_key": "datadog-api-key", "application_key": "datadog-application-key", "severity": "HIGH", "team_handle": "backend-oncall" } ], "email_addresses": [ "user@example.com" ], "name": "engineering-oncall", "pager_duty_notifications": [ { "routing_key": "pagerduty-routing-key", "severity": "CRITICAL" } ], "slack_channels": [ "#incident-response" ], "sns_topic_arns": [ "arn:aws:sns:us-east-1:123456789012:incident-notifications" ] } } ```Example Response
```json {} ```