mirror of https://github.com/hashicorp/boundary
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
425 lines
21 KiB
425 lines
21 KiB
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "Controller API",
|
|
"description": "Controller API for ",
|
|
"version": "0.0.1"
|
|
},
|
|
"schemes": [
|
|
"https",
|
|
"http"
|
|
],
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"paths": {
|
|
"/v1/ec2_catalogs": {
|
|
"get": {
|
|
"operationId": "ControllerService_ListEc2Catalogs",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/v1ListEc2CatalogsResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "The default error structure returned.",
|
|
"schema": {
|
|
"$ref": "#/definitions/apiv1Error"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "ignore_result_limit",
|
|
"description": "Allows all EC2 instances regardless of the configured maximum result limit.",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"format": "boolean"
|
|
}
|
|
],
|
|
"tags": [
|
|
"ControllerService"
|
|
]
|
|
},
|
|
"post": {
|
|
"operationId": "ControllerService_CreateEc2Catalog",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/v1Ec2Catalog"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "The default error structure returned.",
|
|
"schema": {
|
|
"$ref": "#/definitions/apiv1Error"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"description": "The request to create an EC2Catalog. The fields access_key, secret_key, and regions are required.\nThe account_id is a value Watchtower looks up from AWS upon creation and should not be provided. If rotate is\nset to true the provided access key will be rotated to ensure only Watchtower knows the AWS secret key.",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/v1Ec2Catalog"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"ControllerService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/ec2_catalogs/{catalog.id}": {
|
|
"patch": {
|
|
"operationId": "ControllerService_UpdateEc2Catalog2",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/v1UpdateEc2CatalogResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "The default error structure returned.",
|
|
"schema": {
|
|
"$ref": "#/definitions/apiv1Error"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "catalog.id",
|
|
"description": "A system defined identifier unique to this resource. This field is present in all EC2Catalogs.",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/v1UpdateEc2CatalogRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"ControllerService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/ec2_catalogs/{id}": {
|
|
"get": {
|
|
"operationId": "ControllerService_GetEc2Catalog",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/v1Ec2Catalog"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "The default error structure returned.",
|
|
"schema": {
|
|
"$ref": "#/definitions/apiv1Error"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "The id can be the system defined identifier or the friendly name.",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"ControllerService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"operationId": "ControllerService_DeleteEc2Catalog",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/v1DeleteEc2CatalogResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "The default error structure returned.",
|
|
"schema": {
|
|
"$ref": "#/definitions/apiv1Error"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"ControllerService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/ec2_catalogs/{id}:rotate": {
|
|
"post": {
|
|
"operationId": "ControllerService_RotateEc2CatalogAccessKey",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/v1RotateEc2CatalogAccessKeyResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "The default error structure returned.",
|
|
"schema": {
|
|
"$ref": "#/definitions/apiv1Error"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/v1RotateEc2CatalogAccessKeyRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"ControllerService"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"apiv1Error": {
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"description": "The HTTP Status code applicable to this error."
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"description": "An application-specific error string."
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"description": "A human readable explanation specific to this occurrence of the error."
|
|
},
|
|
"details": {
|
|
"$ref": "#/definitions/v1ErrorDetails",
|
|
"description": "Additional metadata regarding the error. Depending on the error different fields will be populated."
|
|
}
|
|
},
|
|
"description": "Error is returned by the JSON API when an error occurs."
|
|
},
|
|
"gatewayruntimeError": {
|
|
"type": "object",
|
|
"properties": {
|
|
"error": {
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"details": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/protobufAny"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"protobufAny": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type_url": {
|
|
"type": "string",
|
|
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"format": "byte",
|
|
"description": "Must be a valid serialized protocol buffer of the above specified type."
|
|
}
|
|
},
|
|
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n ...\n foo := \u0026pb.Foo{}\n if err := ptypes.UnmarshalAny(any, foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }"
|
|
},
|
|
"protobufFieldMask": {
|
|
"type": "object",
|
|
"properties": {
|
|
"paths": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "The set of field mask paths."
|
|
}
|
|
},
|
|
"description": "paths: \"f.a\"\n paths: \"f.b.d\"\n\nHere `f` represents a field in some root message, `a` and `b`\nfields in the message found in `f`, and `d` a field found in the\nmessage in `f.b`.\n\nField masks are used to specify a subset of fields that should be\nreturned by a get operation or modified by an update operation.\nField masks also have a custom JSON encoding (see below).\n\n# Field Masks in Projections\n\nWhen used in the context of a projection, a response message or\nsub-message is filtered by the API to only contain those fields as\nspecified in the mask. For example, if the mask in the previous\nexample is applied to a response message as follows:\n\n f {\n a : 22\n b {\n d : 1\n x : 2\n }\n y : 13\n }\n z: 8\n\nThe result will not contain specific values for fields x,y and z\n(their value will be set to the default, and omitted in proto text\noutput):\n\n\n f {\n a : 22\n b {\n d : 1\n }\n }\n\nA repeated field is not allowed except at the last position of a\npaths string.\n\nIf a FieldMask object is not present in a get operation, the\noperation applies to all fields (as if a FieldMask of all fields\nhad been specified).\n\nNote that a field mask does not necessarily apply to the\ntop-level response message. In case of a REST get operation, the\nfield mask applies directly to the response, but in case of a REST\nlist operation, the mask instead applies to each individual message\nin the returned resource list. In case of a REST custom method,\nother definitions may be used. Where the mask applies will be\nclearly documented together with its declaration in the API. In\nany case, the effect on the returned resource/resources is required\nbehavior for APIs.\n\n# Field Masks in Update Operations\n\nA field mask in update operations specifies which fields of the\ntargeted resource are going to be updated. The API is required\nto only change the values of the fields as specified in the mask\nand leave the others untouched. If a resource is passed in to\ndescribe the updated values, the API ignores the values of all\nfields not covered by the mask.\n\nIf a repeated field is specified for an update operation, new values will\nbe appended to the existing repeated field in the target resource. Note that\na repeated field is only allowed in the last position of a `paths` string.\n\nIf a sub-message is specified in the last position of the field mask for an\nupdate operation, then new value will be merged into the existing sub-message\nin the target resource.\n\nFor example, given the target message:\n\n f {\n b {\n d: 1\n x: 2\n }\n c: [1]\n }\n\nAnd an update message:\n\n f {\n b {\n d: 10\n }\n c: [2]\n }\n\nthen if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\nthen the result will be:\n\n f {\n b {\n d: 10\n x: 2\n }\n c: [1, 2]\n }\n\nAn implementation may provide options to override this default behavior for\nrepeated and message fields.\n\nIn order to reset a field's value to the default, the field must\nbe in the mask and set to the default value in the provided resource.\nHence, in order to reset all fields of a resource, provide a default\ninstance of the resource and set all fields in the mask, or do\nnot provide a mask as described below.\n\nIf a field mask is not present on update, the operation applies to\nall fields (as if a field mask of all fields has been specified).\nNote that in the presence of schema evolution, this may mean that\nfields the client does not know and has therefore not filled into\nthe request will be reset to their default. If this is unwanted\nbehavior, a specific service may require a client to always specify\na field mask, producing an error if not.\n\nAs with get operations, the location of the resource which\ndescribes the updated values in the request message depends on the\noperation kind. In any case, the effect of the field mask is\nrequired to be honored by the API.\n\n## Considerations for HTTP REST\n\nThe HTTP kind of an update operation which uses a field mask must\nbe set to PATCH instead of PUT in order to satisfy HTTP semantics\n(PUT must only be used for full updates).\n\n# JSON Encoding of Field Masks\n\nIn JSON, a field mask is encoded as a single string where paths are\nseparated by a comma. Fields name in each path are converted\nto/from lower-camel naming conventions.\n\nAs an example, consider the following message declarations:\n\n message Profile {\n User user = 1;\n Photo photo = 2;\n }\n message User {\n string display_name = 1;\n string address = 2;\n }\n\nIn proto a field mask for `Profile` may look as such:\n\n mask {\n paths: \"user.display_name\"\n paths: \"photo\"\n }\n\nIn JSON, the same mask is represented as below:\n\n {\n mask: \"user.displayName,photo\"\n }\n\n# Field Masks and Oneof Fields\n\nField masks treat fields in oneofs just as regular fields. Consider the\nfollowing message:\n\n message SampleMessage {\n oneof test_oneof {\n string name = 4;\n SubMessage sub_message = 9;\n }\n }\n\nThe field mask can be:\n\n mask {\n paths: \"name\"\n }\n\nOr:\n\n mask {\n paths: \"sub_message\"\n }\n\nNote that oneof type names (\"test_oneof\" in this case) cannot be used in\npaths.\n\n## Field Mask Verification\n\nThe implementation of any API method which has a FieldMask type field in the\nrequest should verify the included field paths, and return an\n`INVALID_ARGUMENT` error if any path is unmappable.",
|
|
"title": "`FieldMask` represents a set of symbolic field paths, for example:"
|
|
},
|
|
"v1CreateEc2CatalogResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"catalog": {
|
|
"$ref": "#/definitions/v1Ec2Catalog"
|
|
}
|
|
}
|
|
},
|
|
"v1DeleteEc2CatalogResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"existed": {
|
|
"type": "boolean",
|
|
"format": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"v1Ec2Catalog": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "A system defined identifier unique to this resource. This field is present in all EC2Catalogs."
|
|
},
|
|
"friendly_name": {
|
|
"type": "string",
|
|
"description": "An optional field containing a user defined friendly name for this EC2Catalog."
|
|
},
|
|
"access_key": {
|
|
"type": "string",
|
|
"description": "The access key used for authenticating with AWS when retrieving EC2 instance details."
|
|
},
|
|
"secret_key": {
|
|
"type": "string"
|
|
},
|
|
"regions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "The AWS regions from which this catalog will retrieve the EC2 instances."
|
|
},
|
|
"rotate": {
|
|
"type": "boolean",
|
|
"format": "boolean",
|
|
"description": "Rotate instructs this service to rotate the credentials.\nThis field can only be set when access_key and secret_key are also set."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this catalog was created."
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this catalog was last updated."
|
|
}
|
|
},
|
|
"description": "An EC2Catalog is a host catalog that pulls information from AWS."
|
|
},
|
|
"v1ErrorDetails": {
|
|
"type": "object",
|
|
"properties": {
|
|
"trace_id": {
|
|
"type": "string"
|
|
},
|
|
"request_id": {
|
|
"type": "string"
|
|
},
|
|
"request_fields": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"v1GetEc2CatalogResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"catalog": {
|
|
"$ref": "#/definitions/v1Ec2Catalog"
|
|
}
|
|
}
|
|
},
|
|
"v1ListEc2CatalogsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/v1Ec2Catalog"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"v1RotateEc2CatalogAccessKeyRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"v1RotateEc2CatalogAccessKeyResponse": {
|
|
"type": "object"
|
|
},
|
|
"v1UpdateEc2CatalogRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"catalog": {
|
|
"$ref": "#/definitions/v1Ec2Catalog",
|
|
"description": "Allows an existing EC2Catalog to be updated. The field rotate=true requires access_key and secret_key to also be\nset. The only stored fields that can be updated with this call are the regions list and\nthe access_key and secret_key.\nWhen a new access_key and secret_key are provided, a lookup will happen to verify they are for the same aws account\nas the previously provided credentials. If not an error will be returned."
|
|
},
|
|
"update_mask": {
|
|
"$ref": "#/definitions/protobufFieldMask"
|
|
}
|
|
}
|
|
},
|
|
"v1UpdateEc2CatalogResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"catalog": {
|
|
"$ref": "#/definitions/v1Ec2Catalog"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|