@itentialopensource/adapter-kentik

{ "openapi": "3.0.0", "info": { "title": "AS Group Configuration API", "description": "# Overview\nThe AS Group Configuration API provides programmatic access to configuration of AS Groups:\n\n* **AS Group**: ASNs can be logically grouped into an AS group.", "contact": { "name": "Kentik API Engineering", "url": "https://github.com/kentik/api-schema-public" }, "version": "v202212" }, "servers": [ { "url": "https://grpc.api.kentik.com", "variables": {} } ], "paths": { "/as_group/v202212/as_group": { "get": { "tags": [ "ASGroupService" ], "summary": "ListASGroups", "description": "Returns list of configured AS groups.", "operationId": "ListASGroups", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListASGroupsResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "post": { "tags": [ "ASGroupService" ], "summary": "CreateASGroup", "description": "Create configuration for a new AS group. Returns the newly created configuration.", "operationId": "CreateASGroup", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateASGroupRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateASGroupResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/as_group/v202212/as_group/{asGroup.id}": { "put": { "tags": [ "ASGroupService" ], "summary": "UpdateASGroup", "description": "Replaces configuration of a AS group with attributes in the request. Returns the updated configuration.", "operationId": "UpdateASGroup", "parameters": [ { "name": "asGroup.id", "in": "path", "description": "System generated unique identifier", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateASGroupRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateASGroupResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "get": { "tags": [ "ASGroupService" ], "summary": "GetASGroup", "description": "Returns configuration of a AS group specified by ID.", "operationId": "GetASGroup", "parameters": [ { "name": "asGroup.id", "in": "path", "description": "ID of the requested AS group", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetASGroupResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "delete": { "tags": [ "ASGroupService" ], "summary": "DeleteASGroup", "description": "Deletes configuration of a AS group with specific ID.", "operationId": "DeleteASGroup", "parameters": [ { "name": "asGroup.id", "in": "path", "description": "ID of the AS group to be deleted", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/bgp_monitoring/v202210/monitors": { "get": { "tags": [ "BgpMonitoringAdminService" ], "summary": "ListMonitors", "description": "Returns list of all BGP monitors present in the account.", "operationId": "ListMonitors", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMonitorsResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "post": { "tags": [ "BgpMonitoringAdminService" ], "summary": "CreateMonitor", "description": "Creates new BGP Monitor and if successful returns its configuration.", "operationId": "CreateMonitor", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMonitorRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMonitorResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/bgp_monitoring/v202210/monitors/{id}": { "get": { "tags": [ "BgpMonitoringAdminService" ], "summary": "GetMonitor", "description": "Returns configuration of existing BGP monitor with specific ID.", "operationId": "GetMonitor", "parameters": [ { "name": "id", "in": "path", "description": "ID of the BGP monitor to be retrieved", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMonitorResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "delete": { "tags": [ "BgpMonitoringAdminService" ], "summary": "DeleteMonitor", "description": "Delete BGP monitor with with specific ID.", "operationId": "DeleteMonitor", "parameters": [ { "name": "id", "in": "path", "description": "ID of the BGP monitor to be deleted", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "put": { "tags": [ "BgpMonitoringAdminService" ], "summary": "UpdateMonitor", "description": "Updates configuration of BGP monitor with specific ID and returns updated configuration.", "operationId": "UpdateMonitor", "parameters": [ { "name": "id", "in": "path", "description": "System generated unique identifier", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMonitorRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMonitorResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/bgp_monitoring/v202210/monitors/{id}/status": { "put": { "tags": [ "BgpMonitoringAdminService" ], "summary": "SetMonitorStatus", "description": "Sets administrative status of BGP monitor with specific ID.", "operationId": "SetMonitorStatus", "parameters": [ { "name": "id", "in": "path", "description": "ID of the BGP monitor whose status is to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMonitorStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/bgp_monitoring/v202210/metrics": { "post": { "tags": [ "BgpMonitoringDataService" ], "summary": "GetMetricsForTarget", "description": "Retrieve metric data for single BGP prefix and time interval.", "operationId": "GetMetricsForTarget", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMetricsForTargetRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMetricsForTargetResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/bgp_monitoring/v202210/routes": { "post": { "tags": [ "BgpMonitoringDataService" ], "summary": "GetRoutesForTarget", "description": "Retrieve snapshot of route information for single BGP prefix at specific time.", "operationId": "GetRoutesForTarget", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRoutesForTargetRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRoutesForTargetResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/capacity_plan/v202212/capacity_plan": { "get": { "tags": [ "CapacityPlanService" ], "summary": "ListCapacityPlans", "description": "Returns list of capacity plans.", "operationId": "ListCapacityPlans", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCapacityPlansResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/capacity_plan/v202212/capacity_plan/summary": { "get": { "tags": [ "CapacityPlanService" ], "summary": "ListCapacitySummaries", "description": "Returns list of capacity summaries.", "operationId": "ListCapacitySummaries", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCapacitySummariesResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/capacity_plan/v202212/capacity_plan/{id}": { "get": { "tags": [ "CapacityPlanService" ], "summary": "GetCapacityPlan", "description": "Returns capacity plan specified by ID.", "operationId": "GetCapacityPlan", "parameters": [ { "name": "id", "in": "path", "description": "ID of the requested capacity plan", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCapacityPlanResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/capacity_plan/v202212/capacity_plan/{id}/summary": { "get": { "tags": [ "CapacityPlanService" ], "summary": "GetCapacitySummary", "description": "Returns capacity plan summary specified by ID.", "operationId": "GetCapacitySummary", "parameters": [ { "name": "id", "in": "path", "description": "ID of the requested capacity plan summary", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCapacitySummaryResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/cloud_export/v202210/exports": { "get": { "tags": [ "CloudExportAdminService" ], "summary": "ListCloudExports", "description": "Returns a list of all cloud exports in the account.", "operationId": "ListCloudExports", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCloudExportsResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "post": { "tags": [ "CloudExportAdminService" ], "summary": "CreateCloudExport", "description": "Create new cloud export based on configuration in the request.", "operationId": "CreateCloudExport", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCloudExportRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCloudExportResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/cloud_export/v202210/exports/{export.id}": { "put": { "tags": [ "CloudExportAdminService" ], "summary": "UpdateCloudExport", "description": "Replace complete configuration of a cloud export with data in the request.", "operationId": "UpdateCloudExport", "parameters": [ { "name": "export.id", "in": "path", "description": "Unique identifier of the instance", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCloudExportRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCloudExportResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "get": { "tags": [ "CloudExportAdminService" ], "summary": "GetCloudExport", "description": "Returns configuration and status of cloud export with specified ID.", "operationId": "GetCloudExport", "parameters": [ { "name": "export.id", "in": "path", "description": "ID of the cloud export to be retrieved.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCloudExportResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "delete": { "tags": [ "CloudExportAdminService" ], "summary": "DeleteCloudExport", "description": "Delete cloud export with specified ID.", "operationId": "DeleteCloudExport", "parameters": [ { "name": "export.id", "in": "path", "description": "ID of the cloud export to be deleted.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/interface/v202108alpha1/interfaces": { "get": { "tags": [ "InterfaceService" ], "summary": "ListInterface", "description": "Return list of interfaces matches search critera.", "operationId": "ListInterface", "parameters": [ { "name": "filters.text", "in": "query", "description": "Search text match in interface description and alias.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters.deviceIds", "in": "query", "description": "Search by device ID.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters.connectivityTypes", "in": "query", "description": "Search by type of interface connectivity.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v202108alpha1ConnectivityType" } } }, { "name": "filters.networkBoundaries", "in": "query", "description": "Search by type of network boundary.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v202108alpha1NetworkBoundary" } } }, { "name": "filters.providers", "in": "query", "description": "Search by provider.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters.snmpSpeeds", "in": "query", "description": "SNMP speed in Mbps.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "filters.ipTypes", "in": "query", "description": "Search by ip address.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v202108alpha1IpFilter" } } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v202108alpha1ListInterfaceResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "post": { "tags": [ "InterfaceService" ], "summary": "InterfaceCreate", "description": "Create a interface from request. returns created.", "operationId": "InterfaceCreate", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v202108alpha1CreateInterfaceRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v202108alpha1CreateInterfaceResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/interface/v202108alpha1/interfaces/{id}": { "get": { "tags": [ "InterfaceService" ], "summary": "InterfaceGet", "description": "Returns information about a interface specified with ID.", "operationId": "InterfaceGet", "parameters": [ { "name": "id", "in": "path", "description": "ID of interface.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v202108alpha1GetInterfaceResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "delete": { "tags": [ "InterfaceService" ], "summary": "InterfaceDelete", "description": "Deletes the interface specified with id.", "operationId": "InterfaceDelete", "parameters": [ { "name": "id", "in": "path", "description": "ID of interface.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "put": { "tags": [ "InterfaceService" ], "summary": "InterfaceUpdate", "description": "Replaces the entire interface attributes specified with id.", "operationId": "InterfaceUpdate", "parameters": [ { "name": "id", "in": "path", "description": "ID of interface.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v202108alpha1UpdateInterfaceRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v202108alpha1UpdateInterfaceResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/interface/v202108alpha1/manual_classify": { "post": { "tags": [ "InterfaceService" ], "summary": "ManualClassify", "description": "Manually set interface(s) classification.", "operationId": "ManualClassify", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v202108alpha1ManualClassifyRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v202108alpha1ManualClassifyResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/kmi/v202212/market/{marketId}/network/{asn}/{type}": { "post": { "tags": [ "KmiService" ], "summary": "GetASNDetails", "description": "Returns metadata and list of customers, providers, and peers for an Autonomous System.", "operationId": "GetASNDetails", "parameters": [ { "name": "marketId", "in": "path", "description": "Unique Geo Market identifier (as provided by the ListMarkets RPC)", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "asn", "in": "path", "description": "Autonomous System Number (ASN)", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "type", "in": "path", "description": "Type of the requested ASN ('all', 'customer', 'provider', 'peer'). Defaults to 'all'.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetASNDetailsRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetASNDetailsResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/kmi/v202212/market/{marketId}/rankings/{rankType}": { "post": { "tags": [ "KmiService" ], "summary": "GetRankings", "description": "Returns list of KMI rankings.", "operationId": "GetRankings", "parameters": [ { "name": "marketId", "in": "path", "description": "Unique Geo Market identifier (as provided by the ListMarkets RPC)", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "rankType", "in": "path", "description": "Type of the requested ranking ('customer_base', 'customer_base_retail', 'customer_base_wholesome', 'customer_base_backbone', 'customer_growth', 'peering_base'). Defaults to 'customer_base'.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRankingsRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRankingsResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/kmi/v202212/markets": { "get": { "tags": [ "KmiService" ], "summary": "ListMarkets", "description": "Returns list of geo markets for KMI.", "operationId": "ListMarkets", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMarketsResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/label/v202210/labels": { "get": { "tags": [ "LabelService" ], "summary": "ListLabels", "description": "Returns list of all labels configured in the account.", "operationId": "ListLabels", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLabelsResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "post": { "tags": [ "LabelService" ], "summary": "CreateLabel", "description": "Creates a new label based on data in the request.", "operationId": "CreateLabel", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLabelRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLabelResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/label/v202210/labels/{id}": { "delete": { "tags": [ "LabelService" ], "summary": "DeleteLabel", "description": "Deletes label with specified with id.", "operationId": "DeleteLabel", "parameters": [ { "name": "id", "in": "path", "description": "ID of the label to be deleted", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false }, "post": { "tags": [ "LabelService" ], "summary": "UpdateLabel", "description": "Updates configuration of a label.", "operationId": "UpdateLabel", "parameters": [ { "name": "id", "in": "path", "description": "Unique system assigned identifier of the label", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLabelRequest" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLabelResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "deprecated": false } }, "/mkp/v202102alpha1/packages": { "get": { "tags": [ "PackageService" ], "summary": "PackageList", "description": "Returns a list of MKP packages.", "operationId": "PackageList", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v202102alpha1ListPackageResponse" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcSta