{ "swagger": "2.0", "info": { "title": "integration/v1/services.proto", "version": "version not set" }, "tags": [ { "name": "IntegrationService" } ], "consumes": ["application/json"], "produces": ["application/json"], "paths": { "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/integrations": { "get": { "operationId": "IntegrationService_ListIntegrations", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListIntegrationsResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "type", "description": "The type field goes to query parameters", "in": "query", "required": false, "type": "string", "enum": ["INTEGRATION_TYPE_DATADOG", "INTEGRATION_TYPE_PROMETHEUS", "INTEGRATION_TYPE_NEWRELIC"] } ], "tags": ["IntegrationService"] }, "post": { "operationId": "IntegrationService_CreateIntegration", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IntegrationStatusResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "region": { "type": "string" }, "cloudprovider": { "allOf": [ { "$ref": "#/definitions/v1CloudProvider" } ], "title": "Cloud provider (required)" }, "type": { "$ref": "#/definitions/v1IntegrationType" }, "payloads": { "type": "array", "items": { "$ref": "#/definitions/v1IntegrationPayload" } }, "datadog_api_key": { "type": "string" }, "datadog_site": { "$ref": "#/definitions/v1DatadogSite" }, "newrelic_api_key": { "type": "string" }, "newrelic_site": { "$ref": "#/definitions/v1NewrelicSite" } } } } ], "tags": ["IntegrationService"] }, "delete": { "operationId": "IntegrationService_DeleteIntegration", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IntegrationStatusResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "type", "description": "The type field goes to query parameters", "in": "query", "required": false, "type": "string", "enum": ["INTEGRATION_TYPE_DATADOG", "INTEGRATION_TYPE_PROMETHEUS", "INTEGRATION_TYPE_NEWRELIC"] } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/clusters/{cluster_id}/integrations": { "get": { "operationId": "IntegrationService_ListIntegrations2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListIntegrationsResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "type", "description": "The type field goes to query parameters", "in": "query", "required": false, "type": "string", "enum": ["INTEGRATION_TYPE_DATADOG", "INTEGRATION_TYPE_PROMETHEUS", "INTEGRATION_TYPE_NEWRELIC"] } ], "tags": ["IntegrationService"] }, "post": { "operationId": "IntegrationService_CreateIntegration2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IntegrationStatusResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uint64" }, "region": { "type": "string" }, "cloudprovider": { "allOf": [ { "$ref": "#/definitions/v1CloudProvider" } ], "title": "Cloud provider (required)" }, "type": { "$ref": "#/definitions/v1IntegrationType" }, "payloads": { "type": "array", "items": { "$ref": "#/definitions/v1IntegrationPayload" } }, "datadog_api_key": { "type": "string" }, "datadog_site": { "$ref": "#/definitions/v1DatadogSite" }, "newrelic_api_key": { "type": "string" }, "newrelic_site": { "$ref": "#/definitions/v1NewrelicSite" } } } } ], "tags": ["IntegrationService"] }, "delete": { "operationId": "IntegrationService_DeleteIntegration2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IntegrationStatusResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "type", "description": "The type field goes to query parameters", "in": "query", "required": false, "type": "string", "enum": ["INTEGRATION_TYPE_DATADOG", "INTEGRATION_TYPE_PROMETHEUS", "INTEGRATION_TYPE_NEWRELIC"] } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/integrations/{id}": { "put": { "operationId": "IntegrationService_UpdateIntegration", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IntegrationStatusResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id", "description": "Integration ID", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "region": { "type": "string" }, "cloudprovider": { "allOf": [ { "$ref": "#/definitions/v1CloudProvider" } ], "title": "Cloud provider (required)" }, "type": { "$ref": "#/definitions/v1IntegrationType" }, "payloads": { "type": "array", "items": { "$ref": "#/definitions/v1IntegrationPayload" } }, "datadog_api_key": { "type": "string" }, "datadog_site": { "$ref": "#/definitions/v1DatadogSite" }, "newrelic_api_key": { "type": "string" }, "newrelic_site": { "$ref": "#/definitions/v1NewrelicSite" } } } } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/clusters/{cluster_id}/integrations/{id}": { "put": { "operationId": "IntegrationService_UpdateIntegration2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IntegrationStatusResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id", "description": "Integration ID", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uint64" }, "region": { "type": "string" }, "cloudprovider": { "allOf": [ { "$ref": "#/definitions/v1CloudProvider" } ], "title": "Cloud provider (required)" }, "type": { "$ref": "#/definitions/v1IntegrationType" }, "payloads": { "type": "array", "items": { "$ref": "#/definitions/v1IntegrationPayload" } }, "datadog_api_key": { "type": "string" }, "datadog_site": { "$ref": "#/definitions/v1DatadogSite" }, "newrelic_api_key": { "type": "string" }, "newrelic_site": { "$ref": "#/definitions/v1NewrelicSite" } } } } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/integrations/datadog/api_key/validate": { "post": { "operationId": "IntegrationService_ValidateDatadogAPIKey", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ValidateDatadogAPIKeyResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "datadog_api_key": { "type": "string" }, "datadog_site": { "$ref": "#/definitions/v1DatadogSite" } } } } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/clusters/{cluster_id}/integrations/datadog/api_key/validate": { "post": { "operationId": "IntegrationService_ValidateDatadogAPIKey2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ValidateDatadogAPIKeyResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uint64" }, "datadog_api_key": { "type": "string" }, "datadog_site": { "$ref": "#/definitions/v1DatadogSite" } } } } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/integrations/newrelic/api_key/validate": { "post": { "operationId": "IntegrationService_ValidateNewrelicAPIKey", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ValidateNewrelicAPIKeyResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "newrelic_api_key": { "type": "string" }, "newrelic_site": { "$ref": "#/definitions/v1NewrelicSite" } } } } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/clusters/{cluster_id}/integrations/newrelic/api_key/validate": { "post": { "operationId": "IntegrationService_ValidateNewrelicAPIKey2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ValidateNewrelicAPIKeyResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uint64" }, "newrelic_api_key": { "type": "string" }, "newrelic_site": { "$ref": "#/definitions/v1NewrelicSite" } } } } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/metrics_key": { "get": { "operationId": "IntegrationService_GetAllMetricsKey", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1GetAllMetricsKeyResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["IntegrationService"] }, "post": { "operationId": "IntegrationService_CreateMetricsKey", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CreateMetricsKeyResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/clusters/{cluster_id}/metrics_key": { "get": { "operationId": "IntegrationService_GetAllMetricsKey2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1GetAllMetricsKeyResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "query", "required": false, "type": "string", "format": "uint64" } ], "tags": ["IntegrationService"] }, "post": { "operationId": "IntegrationService_CreateMetricsKey2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CreateMetricsKeyResp" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "query", "required": false, "type": "string", "format": "uint64" } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/metrics_key/{key_id}": { "delete": { "operationId": "IntegrationService_DeleteMetricsKey", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "key_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": ["IntegrationService"] } }, "/api/v1/orgs/{org_id}/clusters/{cluster_id}/metrics_key/{key_id}": { "delete": { "operationId": "IntegrationService_DeleteMetricsKey2", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "cluster_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "key_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "project_id", "in": "query", "required": false, "type": "string", "format": "uint64" } ], "tags": ["IntegrationService"] } } }, "definitions": { "protobufAny": { "type": "object", "additionalProperties": {}, "properties": { "@type": { "type": "string" } } }, "rpcStatus": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protobufAny" } } } }, "v1CloudProvider": { "type": "string", "enum": [ "CLOUD_PROVIDER_AWS", "CLOUD_PROVIDER_GCP", "CLOUD_PROVIDER_AZURE", "CLOUD_PROVIDER_ALIBABA", "CLOUD_PROVIDER_LOCAL" ], "title": "- CLOUD_PROVIDER_AWS: Amazon Web Services\n - CLOUD_PROVIDER_GCP: Google Cloud Platform\n - CLOUD_PROVIDER_AZURE: Microsoft Azure\n - CLOUD_PROVIDER_ALIBABA: Alibaba Cloud\n - CLOUD_PROVIDER_LOCAL: Local or on-premises" }, "v1CreateMetricsKeyResp": { "type": "object", "properties": { "key": { "$ref": "#/definitions/v1MetricsKey" }, "query_endpoint": { "type": "string" } } }, "v1DatadogSite": { "type": "string", "enum": [ "DATADOG_SITE_US1", "DATADOG_SITE_US3", "DATADOG_SITE_US5", "DATADOG_SITE_EU1", "DATADOG_SITE_US1_FED", "DATADOG_SITE_AP1", "DATADOG_SITE_AP2" ] }, "v1GetAllMetricsKeyResp": { "type": "object", "properties": { "metrics_keys": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1MetricsKey" } }, "query_endpoint": { "type": "string" } } }, "v1IntegrationPayload": { "type": "string", "enum": ["INTEGRATION_PAYLOAD_METRICS", "INTEGRATION_PAYLOAD_LOGS", "INTEGRATION_PAYLOAD_TRACES"] }, "v1IntegrationStatus": { "type": "string", "enum": ["INTEGRATION_STATUS_NONE", "INTEGRATION_STATUS_ACTIVE", "INTEGRATION_STATUS_ERROR"] }, "v1IntegrationStatusResp": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "cluster_id": { "type": "string", "format": "uint64" }, "type": { "$ref": "#/definitions/v1IntegrationType" }, "status": { "$ref": "#/definitions/v1IntegrationStatus" }, "status_reason": { "description": "status_reason contains error message of the underlying data integration.", "type": "string" }, "payloads": { "type": "array", "items": { "$ref": "#/definitions/v1IntegrationPayload" } }, "datadog_site": { "$ref": "#/definitions/v1DatadogSite" }, "datadog_site_url": { "type": "string" }, "datadog_dashboard_url": { "type": "string" }, "datadog_masked_api_key": { "type": "string" }, "newrelic_site": { "$ref": "#/definitions/v1NewrelicSite" }, "newrelic_site_url": { "type": "string" }, "newrelic_dashboard_url": { "type": "string" }, "newrelic_masked_api_key": { "type": "string" } } }, "v1IntegrationType": { "type": "string", "enum": ["INTEGRATION_TYPE_DATADOG", "INTEGRATION_TYPE_PROMETHEUS", "INTEGRATION_TYPE_NEWRELIC"], "title": "Third-party integration service\nPlease refer to style guide: https://developers.google.com/protocol-buffers/docs/style#enums" }, "v1ListIntegrationsResp": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1IntegrationStatusResp" } }, "total": { "type": "integer", "format": "int32" } } }, "v1MetricsKey": { "type": "object", "properties": { "key_id": { "type": "string", "format": "uint64" }, "key": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } }, "v1NewrelicSite": { "type": "string", "enum": ["NEWRELIC_SITE_US_OTLP", "NEWRELIC_SITE_EU_OTLP"] }, "v1ValidateDatadogAPIKeyResp": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "cluster_id": { "type": "string", "format": "uint64" }, "valid": { "type": "boolean" } } }, "v1ValidateNewrelicAPIKeyResp": { "type": "object", "properties": { "org_id": { "type": "string", "format": "uint64" }, "project_id": { "type": "string", "format": "uint64" }, "cluster_id": { "type": "string", "format": "uint64" }, "valid": { "type": "boolean" } } } } }