{ "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "swagger": "2.0", "info": { "description": "Create, List, and Fetch apps", "title": "Vendor API V3", "contact": { "name": "Replicated, Inc.", "url": "http://www.replicated.com/", "email": "info@replicated.com" }, "version": "3.0.0" }, "host": "api.replicated.com", "basePath": "/vendor/v3", "paths": { "/app": { "post": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "apps" ], "summary": "Create a KOTS app.", "operationId": "createApp", "parameters": [ { "description": "App create parameters.", "name": "Body", "in": "body", "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "description": "Name of the app that is to be created.", "type": "string", "x-go-name": "Name" } } } } ], "responses": { "201": { "$ref": "#/responses/getAppResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" } } } }, "/app/{app_id}": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "apps" ], "summary": "Get a KOTS app.", "operationId": "getAppProperties", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/getAppResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } }, "delete": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "apps" ], "summary": "Delete a KOTS app.", "operationId": "deleteApp", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true } ], "responses": { "201": { "$ref": "#/responses/responseOk" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" } } } }, "/app/{app_id}/channel": { "post": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "channels" ], "summary": "Creates a channel in the KOTS application.", "operationId": "createChannel", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "description": "JSON input", "name": "Body", "in": "body", "required": true, "schema": { "type": "object", "required": [ "name" ], "properties": { "airgapDockerRegistryFormatEnabled": { "description": "AirgapDockerRegistryFormatEnabled airgap bundles built after enabling this will use the Docker Registry format.", "type": "boolean", "x-go-name": "AirgapDockerRegistryFormatEnabled" }, "description": { "description": "Description of the channel that is to be created.", "type": "string", "x-go-name": "Description" }, "enterprisePartnerChannelID": { "description": "Enterprise Partner Channel Id to be added to channel.", "type": "string", "x-go-name": "EnterprisePartnerChannelID" }, "name": { "type": "string", "x-go-name": "Name" }, "semverRequired": { "description": "SemverRequired when enabled, will cause an error when non semver values are used for new releases", "type": "boolean", "x-go-name": "SemverRequired" } } } } ], "responses": { "201": { "$ref": "#/responses/getChannelResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" } } } }, "/app/{app_id}/channel/{channel_id}": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "channels" ], "summary": "Get a channel.", "operationId": "getChannelProperties", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "ChannelID", "description": "Channel identifier", "name": "channel_id", "in": "path", "required": true }, { "type": "boolean", "x-go-name": "ExcludeReleases", "description": "Exclude releases", "name": "excludeReleases", "in": "query" } ], "responses": { "200": { "$ref": "#/responses/getChannelResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } }, "put": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "channels" ], "summary": "Updates a KOTS channel.", "operationId": "updateChannel", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "ChannelID", "description": "Channel identifier", "name": "channel_id", "in": "path", "required": true }, { "description": "Channel update parameters.", "name": "Body", "in": "body", "schema": { "type": "object", "required": [ "name" ], "properties": { "airgapDockerRegistryFormatEnabled": { "description": "AirgapDockerRegistryFormatEnabled airgap bundles built after enabling this will use the Docker Registry format.", "type": "boolean", "x-go-name": "AirgapDockerRegistryFormatEnabled" }, "autoAirgapBuildsValue": { "description": "AutoAirgapBuildsValue of the channel that is to be updated.", "type": "integer", "format": "int64", "x-go-name": "AutoAirgapBuildsValue" }, "channelIcon": { "description": "Icon of the channel that is to be updated.", "type": "string", "x-go-name": "ChannelIcon" }, "description": { "description": "Description of the channel that is to be updated.", "type": "string", "x-go-name": "Description" }, "name": { "description": "Name of the channel that is to be updated.", "type": "string", "x-go-name": "Name" }, "semverRequired": { "description": "SemverRequired when enabled, will cause an error when non semver values are used for new releases", "type": "boolean", "x-go-name": "SemverRequired" } } } } ], "responses": { "200": { "$ref": "#/responses/getChannelResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" } } }, "delete": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "channels" ], "summary": "Archives a KOTS channel.", "operationId": "archiveChannel", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "ChannelID", "description": "Channel identifier", "name": "channel_id", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/responseOk" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" } } } }, "/app/{app_id}/channel/{channel_id}/adoption": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "channels" ], "summary": "Get a channel.", "operationId": "getChannelAdoptionReport", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "ChannelID", "description": "Channel identifier", "name": "channel_id", "in": "path", "required": true }, { "type": "string", "format": "date-time", "x-go-name": "StartDate", "description": "Report start date in YYYY-MM-DD format", "name": "startDate", "in": "query", "required": true }, { "type": "string", "format": "date-time", "x-go-name": "EndDate", "description": "Report end date in YYYY-MM-DD format", "name": "endDate", "in": "query", "required": true } ], "responses": { "200": { "$ref": "#/responses/getChannelAdoptionReportResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/app/{app_id}/channel/{channel_id}/airgap/download-url": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "channelReleases" ], "summary": "Returns the airgap bundle download URL for a channel's release. Defaults to the active release on the channel.", "operationId": "channelReleaseAirgapBundleURL", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "ChannelID", "description": "Channel identifier", "name": "channel_id", "in": "path", "required": true }, { "type": "integer", "format": "int64", "x-go-name": "ChannelSequence", "description": "If provided, the airgap bundle download URL for the given channel sequence will be returned", "name": "channelSequence", "in": "query" } ], "responses": { "200": { "$ref": "#/responses/channelReleaseAirgapBundleURLResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/app/{app_id}/channel/{channel_id}/release/{sequence}": { "post": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "channelReleases" ], "summary": "Update properties for a channel release.", "operationId": "updateChannelRelease", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "ChannelID", "description": "Channel identifier", "name": "channel_id", "in": "path", "required": true }, { "type": "integer", "format": "int64", "x-go-name": "Sequence", "description": "Release identifier", "name": "sequence", "in": "path", "required": true }, { "description": "Update release parameters.", "name": "Body", "in": "body", "schema": { "type": "object", "properties": { "isRequired": { "description": "Prevent this release from being skipped during upgrades", "type": "boolean", "x-go-name": "IsRequired" }, "releaseNotes": { "description": "The updated release notes", "type": "string", "x-go-name": "ReleaseNotes" }, "versionLabel": { "description": "The new version label to use", "type": "string", "x-go-name": "VersionLabel" } } } } ], "responses": { "200": { "$ref": "#/responses/updateChannelRelease" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/app/{app_id}/channel/{channel_id}/release/{sequence}/airgap/build": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "channelReleases" ], "summary": "Trigger airgap build for a channel's release.", "operationId": "channelReleaseAirgapBuild", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "ChannelID", "description": "Channel identifier", "name": "channel_id", "in": "path", "required": true }, { "type": "integer", "format": "int64", "x-go-name": "Sequence", "description": "Release identifier", "name": "sequence", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/channelReleaseAirgapBuildResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/app/{app_id}/channel/{channel_id}/trends": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customers" ], "summary": "Get a customer.", "operationId": "getChannelInstanceTrends", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "ChannelID", "description": "Channel identifier", "name": "channel_id", "in": "path", "required": true }, { "type": "string", "description": "Interval", "name": "Interval", "in": "query", "required": true } ], "responses": { "200": { "$ref": "#/responses/getChannelInstanceTrendsResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/app/{app_id}/channels": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "channels" ], "summary": "List channels for an app.", "operationId": "listChannels", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "ChannelName", "description": "filter by customer name", "name": "channelName", "in": "query" }, { "type": "boolean", "x-go-name": "ExcludeDetail", "description": "Exclude detail", "name": "excludeDetail", "in": "query" } ], "responses": { "200": { "$ref": "#/responses/listChannelsResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/app/{app_id}/customer-entitlements/{customer_id}": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customers" ], "summary": "Get customer entitlements.", "operationId": "getCustomerEntitlements", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "CustomerID", "description": "Customer identifier", "name": "customer_id", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/getCustomerResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/app/{app_id}/customer/{customer_id}": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customers" ], "summary": "Get a customer.", "operationId": "getCustomer", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "CustomerID", "description": "Customer identifier", "name": "customer_id", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/getCustomerResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/app/{app_id}/customer/{customer_id}/instances": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "instances" ], "summary": "List customer instances.", "operationId": "listCustomerInstances", "parameters": [ { "type": "string", "x-go-name": "CustomerID", "description": "Customer identifier", "name": "customer_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/listCustomerInstancesResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/app/{app_id}/customer/{customer_id}/license-download": { "get": { "security": [ { "api_key": [] } ], "produces": [ "text/yaml", "application/json" ], "schemes": [ "https" ], "tags": [ "customers" ], "summary": "Download a customer license file as YAML.", "operationId": "downloadLicense", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "CustomerID", "description": "Customer identifier", "name": "customer_id", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/downloadLicenseResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/app/{app_id}/customers": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customers" ], "summary": "List customers for an app.", "operationId": "listAppCustomers", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "integer", "format": "int64", "x-go-name": "PageSize", "description": "Page size", "name": "pageSize", "in": "query" }, { "type": "integer", "format": "int64", "x-go-name": "CurrentPage", "description": "Current page", "name": "currentPage", "in": "query" }, { "type": "string", "x-go-name": "SortColumn", "description": "Sort column", "name": "sortColumn", "in": "query" }, { "type": "boolean", "x-go-name": "SortDesc", "description": "Sort descending", "name": "sortDesc", "in": "query" }, { "type": "string", "x-go-name": "CustomerName", "description": "filter by customer name", "name": "customerName", "in": "query" } ], "responses": { "200": { "$ref": "#/responses/listCustomersResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/app/{app_id}/customers_csv": { "get": { "security": [ { "api_key": [] } ], "produces": [ "file" ], "schemes": [ "https" ], "tags": [ "app", "customers" ], "summary": "List all customers for a given appId.", "operationId": "listAppCustomersCsv", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "SortColumn", "description": "Sort column", "name": "sortColumn", "in": "query" }, { "type": "boolean", "x-go-name": "SortDesc", "description": "Sort descending", "name": "sortDesc", "in": "query" }, { "type": "string", "x-go-name": "CustomerName", "description": "filter by customer name", "name": "customerName", "in": "query" } ], "responses": { "200": { "$ref": "#/responses/listAppCustomersCsvResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" } } } }, "/app/{app_id}/license-field": { "post": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "app" ], "summary": "Create a license field for a given app.", "operationId": "createLicenseField", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "name": "Body", "in": "body", "required": true, "schema": { "type": "object", "required": [ "name", "type", "title", "hidden" ], "properties": { "default": { "description": "Default value of the entitlement field that is to be created.", "type": "string", "x-go-name": "Default" }, "hidden": { "description": "Hidden flag of the entitlement field that is to be created.", "type": "boolean", "x-go-name": "Hidden" }, "name": { "description": "Name of the entitlement field that is to be created.", "type": "string", "x-go-name": "Name" }, "required": { "description": "Required flag of the entitlement field that is to be created.", "type": "boolean", "x-go-name": "Required" }, "title": { "description": "Title of the entitlement field that is to be created.", "type": "string", "x-go-name": "Title" }, "type": { "description": "Type of the entitlement field that is to be created.", "type": "string", "x-go-name": "Type" } } } } ], "responses": { "200": { "$ref": "#/responses/createLicenseFieldResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/app/{app_id}/license-field/{license_field_name}": { "put": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "app" ], "summary": "Update a license field for a given appId and licenseFieldName.", "operationId": "editLicenseField", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "LicenseFieldName", "description": "Field name", "name": "license_field_name", "in": "path", "required": true }, { "name": "Body", "in": "body", "required": true, "schema": { "type": "object", "required": [ "title", "default", "hidden", "required" ], "properties": { "default": { "description": "Optional default value for this licensefield.", "type": "string", "x-go-name": "Default" }, "hidden": { "description": "Indicates if this field will be visible from the on-premise license screen.", "type": "boolean", "x-go-name": "Hidden" }, "required": { "description": "Indicates if this field will be required from the on-premise license screen.", "type": "boolean", "x-go-name": "Required" }, "title": { "description": "Title of custom license field to display.", "type": "string", "x-go-name": "Title" } } } } ], "responses": { "200": { "$ref": "#/responses/editLicenseFieldResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } }, "delete": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "app" ], "summary": "Delete a field for a given app and named field.", "operationId": "deleteLicenseField", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true }, { "type": "string", "x-go-name": "LicenseFieldName", "description": "Field name", "name": "license_field_name", "in": "path", "required": true }, { "type": "boolean", "x-go-name": "PreserveFields", "description": "Field name", "name": "preserve_fields", "in": "query" } ], "responses": { "200": { "$ref": "#/responses/deleteLicenseFieldResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/app/{app_id}/license-fields": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "app" ], "summary": "List license fields for a given appId.", "operationId": "listLicenseFields", "parameters": [ { "type": "string", "x-go-name": "AppID", "description": "App identifier", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/listLicenseFieldsResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/apps": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "apps" ], "summary": "List apps for a team.", "operationId": "apps", "responses": { "200": { "$ref": "#/responses/listAppsResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/custom-hostname": { "put": { "security": [ { "api_key": [] } ], "description": "Create a custom hostname", "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customHostnames" ], "operationId": "createCustomHostname", "parameters": [ { "name": "Body", "in": "body", "schema": { "type": "object", "properties": { "download_portal": { "$ref": "#/definitions/CreateCustomHostnameParams" }, "proxy": { "$ref": "#/definitions/CreateCustomHostnameParams" }, "registry": { "$ref": "#/definitions/CreateCustomHostnameParams" } } } } ], "responses": { "200": { "$ref": "#/responses/createCustomHostnameResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } }, "delete": { "security": [ { "api_key": [] } ], "description": "Delete a custom hostname", "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customHostnames" ], "operationId": "deleteCustomHostname", "parameters": [ { "name": "Body", "in": "body", "schema": { "type": "object", "properties": { "download_portal": { "$ref": "#/definitions/DeleteCustomHostnameParams" }, "proxy": { "$ref": "#/definitions/DeleteCustomHostnameParams" }, "registry": { "$ref": "#/definitions/DeleteCustomHostnameParams" } } } } ], "responses": { "200": { "$ref": "#/responses/deleteCustomHostnameResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/custom-hostnames": { "get": { "security": [ { "api_key": [] } ], "description": "List custom hostnames for a team", "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customHostnames" ], "operationId": "listCustomHostnames", "responses": { "200": { "$ref": "#/responses/listCustomHostnamesResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/customer": { "post": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customers" ], "summary": "Create a KOTS customer.", "operationId": "createCustomer", "parameters": [ { "description": "Customer create parameters.", "name": "Body", "in": "body", "schema": { "type": "object", "required": [ "name", "app_id", "channel_id" ], "properties": { "app_id": { "description": "App to which the channel is associated.", "type": "string", "x-go-name": "AppID" }, "channel_id": { "description": "Channel to which the customer license is associated.", "type": "string", "x-go-name": "ChannelID" }, "email": { "description": "Email address of the customer that is to be created", "type": "string", "x-go-name": "Email" }, "entitlementValues": { "type": "array", "items": { "$ref": "#/definitions/EntitlementValue" }, "x-go-name": "EntitlementValues" }, "expires_at": { "type": "string", "x-go-name": "ExpiresAtStr" }, "is_airgap_enabled": { "type": "boolean", "x-go-name": "IsAirgapEnabled" }, "is_geoaxis_supported": { "type": "boolean", "x-go-name": "IsGeoaxisSupported" }, "is_gitops_supported": { "type": "boolean", "x-go-name": "IsGitopsSupported" }, "is_identity_service_supported": { "type": "boolean", "x-go-name": "IsIdentityServiceSupported" }, "is_snapshot_supported": { "type": "boolean", "x-go-name": "IsSnapshotSupported" }, "is_support_bundle_upload_enabled": { "type": "boolean", "x-go-name": "IsSupportBundleUploadEnabled" }, "name": { "description": "Name of the customer that is to be created.", "type": "string", "x-go-name": "Name" }, "type": { "$ref": "#/definitions/LicenseType" } } } } ], "responses": { "201": { "$ref": "#/responses/getCustomerResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" } } } }, "/customer/{customer_id}": { "put": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customers" ], "summary": "Update a customer.", "operationId": "updateCustomer", "parameters": [ { "type": "string", "x-go-name": "CustomerID", "description": "Customer identifier", "name": "customer_id", "in": "path", "required": true }, { "description": "Update customer parameters.", "name": "Body", "in": "body", "schema": { "type": "object", "required": [ "name", "app_id" ], "properties": { "app_id": { "description": "App to which the channel is associated.", "type": "string", "x-go-name": "AppID" }, "channel_id": { "description": "The channel id to which the customer is associated.", "type": "string", "x-go-name": "ChannelID" }, "email": { "description": "Email of the customer that is to be updated", "type": "string", "x-go-name": "Email" }, "entitlementValues": { "description": "Applies ony to the currently selected app", "type": "array", "items": { "$ref": "#/definitions/EntitlementValue" }, "x-go-name": "EntitlementValues" }, "expires_at": { "description": "Format is YYYY-MM-DD, e.g. 2021-02-24", "type": "string", "x-go-name": "ExpiresAtStr" }, "is_airgap_enabled": { "type": "boolean", "x-go-name": "IsAirgapEnabled" }, "is_geoaxis_supported": { "type": "boolean", "x-go-name": "IsGeoaxisSupported" }, "is_gitops_supported": { "type": "boolean", "x-go-name": "IsGitopsSupported" }, "is_identity_service_supported": { "type": "boolean", "x-go-name": "IsIdentityServiceSupported" }, "is_snapshot_supported": { "type": "boolean", "x-go-name": "IsSnapshotSupported" }, "is_support_bundle_upload_enabled": { "type": "boolean", "x-go-name": "IsSupportBundleUploadEnabled" }, "name": { "description": "Name of the customer that is to be updated.", "type": "string", "x-go-name": "Name" }, "type": { "$ref": "#/definitions/LicenseType" } } } } ], "responses": { "200": { "$ref": "#/responses/getCustomerResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/customer/{customer_id}/airgap/password": { "post": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customers" ], "summary": "Regenerate the airgap password used to access the customer's download portal.", "operationId": "postAirgapPassword", "parameters": [ { "type": "string", "x-go-name": "CustomerID", "description": "Customer identifier", "name": "customer_id", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/postAirgapPasswordResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/customer/{customer_id}/archive": { "post": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customers" ], "summary": "Archive a customer.", "operationId": "archiveCustomer", "parameters": [ { "type": "string", "x-go-name": "CustomerID", "description": "Customer identifier", "name": "customer_id", "in": "path", "required": true } ], "responses": { "204": { "$ref": "#/responses/responseNoContent" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/customer/{customer_id}/unarchive": { "post": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customers" ], "summary": "Unarchive a customer.", "operationId": "unarchiveCustomer", "parameters": [ { "type": "string", "x-go-name": "CustomerID", "description": "Customer identifier", "name": "customer_id", "in": "path", "required": true } ], "responses": { "204": { "$ref": "#/responses/responseNoContent" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/customers": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customers" ], "summary": "List all customers.", "operationId": "listCustomers", "parameters": [ { "type": "integer", "format": "int64", "x-go-name": "PageSize", "description": "Page size", "name": "pageSize", "in": "query" }, { "type": "integer", "format": "int64", "x-go-name": "CurrentPage", "description": "Current page", "name": "currentPage", "in": "query" }, { "type": "string", "x-go-name": "SortColumn", "description": "Sort column", "name": "sortColumn", "in": "query" }, { "type": "boolean", "x-go-name": "SortDesc", "description": "Sort descending", "name": "sortDesc", "in": "query" } ], "responses": { "200": { "$ref": "#/responses/listCustomersResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/customers/search": { "post": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "customers" ], "summary": "Search all customers for a given team context.", "operationId": "searchTeamCustomers", "parameters": [ { "description": "Search licenses parameters.", "name": "Body", "in": "body", "required": true, "schema": { "type": "object", "required": [ "query" ], "properties": { "app_id": { "type": "string", "x-go-name": "AppID" }, "channel_names": { "type": "array", "items": { "type": "string" }, "x-go-name": "ChannelNames" }, "include_active": { "type": "boolean", "x-go-name": "IncludeActive" }, "include_archived": { "type": "boolean", "x-go-name": "IncludeArchived" }, "include_community": { "type": "boolean", "x-go-name": "IncludeCommunity" }, "include_dev": { "type": "boolean", "x-go-name": "IncludeDev" }, "include_inactive": { "type": "boolean", "x-go-name": "IncludeInactive" }, "include_paid": { "type": "boolean", "x-go-name": "IncludePaid" }, "include_trial": { "type": "boolean", "x-go-name": "IncludeTrial" }, "instance_preview": { "type": "boolean", "x-go-name": "InstancePreview" }, "max_instances": { "type": "integer", "format": "int64", "x-go-name": "MaxInstances" }, "offset": { "type": "integer", "format": "int64", "x-go-name": "Offset" }, "page_size": { "type": "integer", "format": "int64", "x-go-name": "PageSize" }, "query": { "type": "string", "x-go-name": "Query" }, "sort_direction": { "type": "string", "x-go-name": "SortDirection" }, "sort_field": { "type": "string", "x-go-name": "SortField" } } } } ], "responses": { "200": { "$ref": "#/responses/searchTeamCustomersResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" } } } }, "/external_registries": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "externalRegistries" ], "summary": "Test external registry for a team.", "operationId": "testExternalRegistry", "parameters": [ { "description": "ExternalRegistry create parameters.", "name": "Body", "in": "body", "schema": { "type": "object", "required": [ "endpoint", "image" ], "properties": { "endpoint": { "description": "Endpoint of the external registry.", "type": "string", "x-go-name": "Endpoint" }, "image": { "description": "Image to test pulling.", "type": "string", "x-go-name": "Image" }, "password": { "description": "Password to use, provide only when testing before saving", "type": "string", "x-go-name": "Password" }, "username": { "description": "Username to use, provide only when testing before saving", "type": "string", "x-go-name": "Username" } } } } ], "responses": { "200": { "$ref": "#/responses/testExternalRegistryResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/external_registry": { "post": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "team" ], "summary": "Creates an external registry with the specified parameters.", "operationId": "createExternalRegistry", "parameters": [ { "description": "ExternalRegistry create parameters.", "name": "Body", "in": "body", "schema": { "type": "object", "required": [ "endpoint", "username", "password" ], "properties": { "authType": { "description": "Auth type for the upstream registry (optional)", "type": "string", "x-go-name": "AuthType" }, "endpoint": { "description": "Endpoint of the upstream registry.", "type": "string", "x-go-name": "Endpoint" }, "password": { "description": "Password for authentication with the upstream registry.", "type": "string", "x-go-name": "Password" }, "provider": { "description": "Provider of the upstream registry. (optional)", "type": "string", "x-go-name": "Provider" }, "skipValidation": { "description": "SkipValidation just saves the values without checking if the registry is valid.", "type": "boolean", "x-go-name": "SkipValidation" }, "username": { "description": "Username for authentication with the upstream registry.", "type": "string", "x-go-name": "Username" } } } } ], "responses": { "201": { "$ref": "#/responses/createExternalRegistryResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" } } } }, "/external_registry/logs": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "externalRegistries" ], "summary": "Get the logs for a specific external registry.", "operationId": "externalRegistryLogs", "responses": { "200": { "$ref": "#/responses/listExternalRegistriesResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } }, "/external_registry/{endpoint}": { "post": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "team" ], "summary": "Deletes an external registry by endpoint.", "operationId": "deleteExternalRegistry", "parameters": [ { "type": "string", "x-go-name": "Endpoint", "description": "Endpoint identifier", "name": "endpoint", "in": "path", "required": true } ], "responses": { "204": { "$ref": "#/responses/responseNoContent" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" } } } }, "/heritage-eol-notice": { "get": { "security": [ { "api_key": [] } ], "produces": [ "application/json" ], "schemes": [ "https" ], "summary": "Get Heritage EOL notice if one should be shown.", "operationId": "getHeritageEOLNotice", "responses": { "200": { "$ref": "#/responses/getHeritageEOLNoticeResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } }, "post": { "security": [ { "api_key": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "summary": "Dismiss Heritage EOL Notice.", "operationId": "dismissHeritageEOLNotice", "parameters": [ { "description": "App create parameters.", "name": "Body", "in": "body", "schema": { "type": "object", "properties": { "nextDisplayAt": { "description": "Timestamp indicating when to display the message next time. Default is 30 days from now.", "type": "string", "format": "date-time", "x-go-name": "NextDisplayAt" } } } } ], "responses": { "200": { "$ref": "#/responses/responseOk" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" } } } }, "/v3/custom-hostname/default": { "put": { "description": "Set the default hostname", "produces": [ "application/json" ], "schemes": [ "https" ], "tags": [ "defaultHostname" ], "operationId": "setDefaultHostname", "parameters": [ { "name": "Body", "in": "body", "schema": { "type": "object", "properties": { "download_portal": { "$ref": "#/definitions/SetDefaultHostnameParams" } } } } ], "responses": { "200": { "$ref": "#/responses/setDefaultHostnameResponse" }, "400": { "$ref": "#/responses/responseErrBadRequest" }, "401": { "$ref": "#/responses/responseErrUnauthorized" }, "403": { "$ref": "#/responses/responseErrForbidden" }, "404": { "$ref": "#/responses/responseErrNotFound" } } } } }, "definitions": { "AppWithChannels": { "type": "object", "properties": { "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" }, "x-go-name": "Channels" }, "created": { "type": "string", "format": "date-time", "x-go-name": "CreatedAt" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "ID" }, "isArchived": { "type": "boolean", "x-go-name": "IsArchived" }, "isKotsApp": { "type": "boolean", "x-go-name": "IsKotsApp" }, "name": { "type": "string", "x-go-name": "Name" }, "renamedAt": { "type": "string", "format": "date-time", "x-go-name": "RenamedAt" }, "slug": { "type": "string", "x-go-name": "Slug" }, "teamId": { "type": "string", "x-go-name": "TeamID" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/handlers/replv3/apps" }, "Channel": { "type": "object", "properties": { "GetAppID": { "type": "string" }, "GetAppName": { "type": "string" }, "GetAppSlug": { "type": "string" }, "GetCreatedAt": { "type": "string", "format": "date-time" }, "GetEnterprisePartnerChannelID": { "type": "string" }, "GetID": { "type": "string" }, "GetIsDefault": { "type": "boolean" }, "GetIsSemverRequired": { "type": "boolean" }, "GetName": { "type": "string" }, "GetSlug": { "type": "string" }, "GetType": { "type": "string" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/channel/types" }, "CreateCustomHostnameParams": { "type": "object", "properties": { "hostname": { "type": "string", "x-go-name": "Hostname" }, "verification_type": { "type": "string", "x-go-name": "VerificationType" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/handlers/replv3/custom_hostnames" }, "CustomHostname": { "type": "object", "properties": { "cloudflare_custom_hostname_id": { "type": "string", "x-go-name": "CloudflareCustomHostnameID" }, "created_at": { "type": "string", "format": "date-time", "x-go-name": "CreatedAt" }, "domain_txt_record_name": { "type": "string", "x-go-name": "DomainTxtRecordName" }, "domain_txt_record_value": { "type": "string", "x-go-name": "DomainTxtRecordValue" }, "domain_verification_status": { "type": "string", "x-go-name": "DomainVerificationStatus" }, "domain_verification_type": { "type": "string", "x-go-name": "DomainVerificationType" }, "failure_count": { "type": "integer", "format": "int64", "x-go-name": "FailureCount" }, "failure_reason": { "type": "string", "x-go-name": "FailureReason" }, "hostname": { "type": "string", "x-go-name": "Hostname" }, "is_default": { "type": "boolean", "x-go-name": "IsDefault" }, "origin_server": { "type": "string", "x-go-name": "OriginServer" }, "team_id": { "type": "string", "x-go-name": "TeamID" }, "tls_txt_record_name": { "type": "string", "x-go-name": "TLSTxtRecordName" }, "tls_txt_record_value": { "type": "string", "x-go-name": "TLSTxtRecordValue" }, "tls_verification_status": { "type": "string", "x-go-name": "TLSVerificationStatus" }, "tls_verification_type": { "type": "string", "x-go-name": "TLSVerificationType" }, "updated_at": { "type": "string", "format": "date-time", "x-go-name": "UpdatedAt" }, "verification_errors": { "type": "array", "items": { "type": "string" }, "x-go-name": "VerificationErrors" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/customhostname" }, "Customer": { "type": "object", "properties": { "actions": { "$ref": "#/definitions/CustomerActions" }, "activeInstances": { "$ref": "#/definitions/InstancePreview" }, "airgap": { "type": "boolean", "x-go-name": "IsAirgapEnabled" }, "appType": { "type": "string", "x-go-name": "AppType" }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" }, "x-go-name": "Channels" }, "createdAt": { "type": "string", "format": "date-time", "x-go-name": "CreatedAt" }, "downloadPortalUrl": { "type": "string", "x-go-name": "DownloadPortalURL" }, "email": { "type": "string", "x-go-name": "Email" }, "entitlements": { "type": "array", "items": { "$ref": "#/definitions/EntitlementValue" }, "x-go-name": "Entitlements" }, "expiresAt": { "type": "string", "format": "date-time", "x-go-name": "ExpiresAt" }, "id": { "type": "string", "x-go-name": "ID" }, "inactiveInstances": { "$ref": "#/definitions/InstancePreview" }, "installationId": { "type": "string", "x-go-name": "InstallationID" }, "installationVersion": { "type": "string", "x-go-name": "InstallationVersion" }, "installedReleaseLabel": { "type": "string", "x-go-name": "InstalledReleaseLabel" }, "installedReleaseSequence": { "type": "integer", "format": "int64", "x-go-name": "InstalledReleaseSequence" }, "instances": { "type": "array", "items": { "$ref": "#/definitions/CustomerInstance" }, "x-go-name": "Instances" }, "isArchived": { "type": "boolean", "x-go-name": "IsArchived" }, "isGeoaxisSupported": { "type": "boolean", "x-go-name": "IsGeoaxisSupported" }, "isGitopsSupported": { "type": "boolean", "x-go-name": "IsGitopsSupported" }, "isIdentityServiceSupported": { "type": "boolean", "x-go-name": "IsIdentityServiceSupported" }, "isInstancesLimited": { "type": "boolean", "x-go-name": "IsInstancesLimited" }, "isSnapshotSupported": { "type": "boolean", "x-go-name": "IsSnapshotSupported" }, "isSupportBundleUploadEnabled": { "type": "boolean", "x-go-name": "IsSupportBundleUploadEnabled" }, "lowercaseName": { "description": "Lowercase fields for ES customer sorting", "type": "string", "x-go-name": "LowercaseName" }, "name": { "type": "string", "x-go-name": "Name" }, "shipInstallStatus": { "$ref": "#/definitions/ShipInstallStatus" }, "teamId": { "type": "string", "x-go-name": "TeamID" }, "type": { "$ref": "#/definitions/LicenseType" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/customer/types" }, "CustomerActions": { "type": "object", "properties": { "shipApply": { "type": "string", "x-go-name": "ShipApply" }, "shipApplyDocker": { "type": "string", "x-go-name": "ShipApplyDocker" }, "shipInitCloud": { "type": "string", "x-go-name": "ShipInitCloud" }, "shipInitHomebrew": { "type": "string", "x-go-name": "ShipInitHomebrew" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/customer/types" }, "CustomerInstance": { "type": "object", "properties": { "active": { "type": "boolean", "x-go-name": "Active" }, "appStatus": { "type": "string", "x-go-name": "AppStatus" }, "cloud": { "type": "string", "x-go-name": "Cloud" }, "clusterId": { "type": "string", "x-go-name": "ClusterID" }, "createdAt": { "type": "string", "format": "date-time", "x-go-name": "CreatedAt" }, "instanceId": { "type": "string", "x-go-name": "InstanceID" }, "isDummyInstance": { "type": "boolean", "x-go-name": "IsDummyInstance" }, "isKurl": { "type": "boolean", "x-go-name": "IsKurl" }, "k8sVersion": { "type": "string", "x-go-name": "K8sVersion" }, "kotsVersion": { "type": "string", "x-go-name": "KotsVersion" }, "kurlNodeCountReady": { "type": "integer", "format": "int64", "x-go-name": "KurlNodeCountReady" }, "kurlNodeCountTotal": { "type": "integer", "format": "int64", "x-go-name": "KurlNodeCountTotal" }, "lastActive": { "type": "string", "format": "date-time", "x-go-name": "LastActive" }, "licenseId": { "type": "string", "x-go-name": "LicenseID" }, "versionHistory": { "type": "array", "items": { "$ref": "#/definitions/CustomerInstanceVersionHistory" }, "x-go-name": "VersionHistory" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/customer/types" }, "CustomerInstanceVersionHistory": { "type": "object", "properties": { "clusterId": { "type": "string", "x-go-name": "ClusterID" }, "downstreamChannelId": { "type": "string", "x-go-name": "DownstreamChannelID" }, "downstreamReleaseSequence": { "type": "integer", "format": "int64", "x-go-name": "DownstreamReleaseSequence" }, "instanceId": { "type": "string", "x-go-name": "InstanceID" }, "intervalLast": { "type": "string", "format": "date-time", "x-go-name": "IntervalLast" }, "intervalStart": { "type": "string", "format": "date-time", "x-go-name": "IntervalStart" }, "nativeHelmCount": { "type": "integer", "format": "int32", "x-go-name": "NativeHelmCount" }, "replHelmCount": { "type": "integer", "format": "int32", "x-go-name": "ReplHelmCount" }, "versionLabel": { "type": "string", "x-go-name": "VersionLabel" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/customer/types" }, "DeleteCustomHostnameParams": { "type": "object", "properties": { "hostname": { "type": "string", "x-go-name": "Hostname" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/handlers/replv3/custom_hostnames" }, "EnterpriseChannel": { "type": "object", "properties": { "description": { "type": "string", "x-go-name": "Description" }, "enterprise_name": { "type": "string", "x-go-name": "EnterpriseName" }, "id": { "type": "string", "x-go-name": "ID" }, "installer": { "$ref": "#/definitions/EnterpriseInstaller" }, "name": { "type": "string", "x-go-name": "Name" }, "policies": { "type": "array", "items": { "$ref": "#/definitions/EnterprisePolicy" }, "x-go-name": "Policies" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/enterprise" }, "EnterpriseInstaller": { "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID" }, "partner_id": { "type": "string", "x-go-name": "PartnerID" }, "yaml": { "type": "string", "x-go-name": "Yaml" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/enterprise" }, "EnterprisePolicy": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "x-go-name": "CreatedAt" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "ID" }, "name": { "type": "string", "x-go-name": "Name" }, "partner_id": { "type": "string", "x-go-name": "PartnerID" }, "policy": { "type": "string", "x-go-name": "Policy" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/enterprise" }, "EntitlementField": { "type": "object", "properties": { "default": { "type": "string", "x-go-name": "Default" }, "hidden": { "type": "boolean", "x-go-name": "Hidden" }, "name": { "type": "string", "x-go-name": "Name" }, "required": { "type": "boolean", "x-go-name": "Required" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "$ref": "#/definitions/EntitlementValueType" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/customer/types" }, "EntitlementValue": { "type": "object", "properties": { "name": { "type": "string", "x-go-name": "Name" }, "value": { "type": "string", "x-go-name": "Value" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/customer/types" }, "EntitlementValueType": { "type": "string", "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/customer/types" }, "ExternalRegistry": { "type": "object", "properties": { "authType": { "type": "string", "x-go-name": "AuthType" }, "createdAt": { "type": "string", "format": "date-time", "x-go-name": "CreatedAt" }, "endpoint": { "type": "string", "x-go-name": "Endpoint" }, "provider": { "type": "string", "x-go-name": "Provider" }, "teamId": { "type": "string", "x-go-name": "TeamID" }, "updatedAt": { "type": "string", "format": "date-time", "x-go-name": "UpdatedAt" }, "username": { "type": "string", "x-go-name": "Username" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots" }, "ExternalRegistryLog": { "type": "object", "properties": { "action": { "type": "string", "x-go-name": "Action" }, "createdAt": { "type": "string", "format": "date-time", "x-go-name": "CreatedAt" }, "image": { "type": "string", "x-go-name": "Image" }, "isSuccess": { "type": "boolean", "x-go-name": "IsSuccess" }, "statusCode": { "type": "integer", "format": "int64", "x-go-name": "StatusCode" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots" }, "HeritageAppUsage": { "type": "object", "properties": { "airgapCustomers": { "type": "integer", "format": "int64", "x-go-name": "AirgapCustomers" }, "onlineCustomers": { "type": "integer", "format": "int64", "x-go-name": "OnlineCustomers" }, "onlineInstances": { "type": "integer", "format": "int64", "x-go-name": "OnlineInstances" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/handlers/replv3/users" }, "InstancePreview": { "type": "object", "properties": { "instances": { "type": "array", "items": { "$ref": "#/definitions/CustomerInstance" }, "x-go-name": "Instances" }, "moreAvailable": { "type": "boolean", "x-go-name": "MoreAvailable" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/customer/types" }, "InstanceTrends": { "type": "object", "properties": { "completedUpgradesPreviousPeriod": { "type": "integer", "format": "int64", "x-go-name": "CompletedUpgradesPreviousPeriod" }, "completedUpgradesThisPeriod": { "type": "integer", "format": "int64", "x-go-name": "CompletedUpgradesThisPeriod" }, "lastThreeVersionsPercentageBefore": { "type": "number", "format": "double", "x-go-name": "LastThreeVersionsPercentageBefore" }, "lastThreeVersionsPercentageToday": { "type": "number", "format": "double", "x-go-name": "LastThreeVersionsPercentageToday" }, "medianInstanceAgeBefore": { "type": "integer", "format": "int64", "x-go-name": "MedianInstanceAgeBefore" }, "medianInstanceAgeToday": { "type": "integer", "format": "int64", "x-go-name": "MedianInstanceAgeToday" }, "uniqueVersionsBefore": { "type": "integer", "format": "int64", "x-go-name": "UniqueVersionsBefore" }, "uniqueVersionsToday": { "type": "integer", "format": "int64", "x-go-name": "UniqueVersionsToday" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/channel/types" }, "KotsChannelRelease": { "type": "object", "properties": { "airgapBuildError": { "type": "string", "x-go-name": "AirgapBuildError" }, "airgapBuildStatus": { "type": "string", "x-go-name": "AirgapBuildStatus" }, "channelIcon": { "type": "string", "x-go-name": "ChannelIcon" }, "channelId": { "type": "string", "x-go-name": "ChannelID" }, "channelName": { "type": "string", "x-go-name": "ChannelName" }, "channelSequence": { "type": "integer", "format": "int64", "x-go-name": "ChannelSequence" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "hasKurlInstaller": { "type": "boolean", "x-go-name": "HasKurlInstaller" }, "isRequired": { "type": "boolean", "x-go-name": "IsRequired" }, "lintResult": { "$ref": "#/definitions/LintResult" }, "proxyRegistryDomain": { "type": "string", "x-go-name": "ProxyRegistryDomain" }, "registrySecret": { "type": "string", "x-go-name": "RegistrySecret" }, "releaseNotes": { "type": "string", "x-go-name": "ReleaseNotes" }, "releasedAt": { "type": "string", "format": "date-time", "x-go-name": "ReleasedAt" }, "replicatedRegistryDomain": { "type": "string", "x-go-name": "ReplicatedRegistryDomain" }, "semver": { "type": "string", "x-go-name": "Semver" }, "sequence": { "type": "integer", "format": "int64", "x-go-name": "Sequence" }, "updated": { "type": "string", "format": "date-time", "x-go-name": "Updated" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/channel/kots" }, "LicenseType": { "type": "string", "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/customer/types" }, "LintExpression": { "type": "object", "properties": { "message": { "type": "string", "x-go-name": "Message" }, "path": { "type": "string", "x-go-name": "Path" }, "positions": { "type": "array", "items": { "$ref": "#/definitions/LintExpressionItemPosition" }, "x-go-name": "Positions" }, "rule": { "type": "string", "x-go-name": "Rule" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "github.com/replicatedhq/kots-lint/pkg/kots" }, "LintExpressionItemLinePosition": { "type": "object", "properties": { "line": { "type": "integer", "format": "int64", "x-go-name": "Line" } }, "x-go-package": "github.com/replicatedhq/kots-lint/pkg/kots" }, "LintExpressionItemPosition": { "type": "object", "properties": { "start": { "$ref": "#/definitions/LintExpressionItemLinePosition" } }, "x-go-package": "github.com/replicatedhq/kots-lint/pkg/kots" }, "LintResult": { "type": "object", "properties": { "isLintingComplete": { "type": "boolean", "x-go-name": "IsLintingComplete" }, "lintExpressions": { "type": "array", "items": { "$ref": "#/definitions/LintExpression" }, "x-go-name": "LintExpressions" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/lint" }, "SetDefaultHostnameParams": { "type": "object", "properties": { "hostname": { "type": "string", "x-go-name": "Hostname" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/handlers/replv3/custom_hostnames" }, "ShipInstallStatus": { "type": "object", "properties": { "status": { "type": "string", "x-go-name": "Status" }, "updatedAt": { "type": "string", "format": "date-time", "x-go-name": "UpdatedAt" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/customer/sharedtypes" }, "VersionAdoption": { "type": "object", "properties": { "instanceCount": { "type": "integer", "format": "int64", "x-go-name": "InstanceCount" }, "versionLabel": { "type": "string", "x-go-name": "VersionLabel" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/channel/types" }, "VersionAdoptionReport": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "x-go-name": "Date" }, "versions": { "type": "array", "items": { "$ref": "#/definitions/VersionAdoption" }, "x-go-name": "Versions" } }, "x-go-package": "github.com/replicatedhq/vandoor/vendor-api/kots/channel/types" } }, "responses": { "channelReleaseAirgapBuildResponse": { "description": "ChannelReleaseAirgapBuildResponse contains empty JSON object", "schema": { "type": "object" } }, "channelReleaseAirgapBundleURLResponse": { "description": "ChannelReleaseAirgapBundleURLResponse contains the airgap bundle download URL", "schema": { "type": "object", "properties": { "url": { "type": "string", "x-go-name": "URL" } } } }, "createCustomHostnameResponse": { "description": "CreateCustomHostnameResponse contains whether or not the request was successful", "schema": { "type": "object", "properties": { "success": { "type": "boolean", "x-go-name": "Success" } } } }, "createExternalRegistryResponse": { "description": "CreateExternalRegistryResponse represents an external registry.", "schema": { "type": "object", "properties": { "external_registry": { "$ref": "#/definitions/ExternalRegistry" } } } }, "createLicenseFieldResponse": { "description": "CreateLicenseFieldResponse contains the response of all license fields", "schema": { "$ref": "#/definitions/EntitlementField" } }, "deleteCustomHostnameResponse": { "description": "DeleteCustomHostnameResponse contains whether or not the request was successful", "schema": { "type": "object", "properties": { "success": { "type": "boolean", "x-go-name": "Success" } } } }, "deleteLicenseFieldResponse": { "description": "DeleteLicenseFieldResponse contains the response from deleting a license field" }, "downloadLicenseResponse": { "description": "DownloadLicenseResponse contains the license yaml", "schema": { "type": "string" } }, "editLicenseFieldResponse": { "description": "EditLicenseFieldResponse contains the license fields", "schema": { "$ref": "#/definitions/EntitlementField" } }, "externalRegistryLogsResponse": { "description": "ExternalRegistryLogsResponse contains the JSON external registry logs", "schema": { "type": "object", "properties": { "logs": { "type": "array", "items": { "$ref": "#/definitions/ExternalRegistryLog" }, "x-go-name": "Logs" } } } }, "getAppResponse": { "description": "GetAppResponse represents an app.", "schema": { "type": "object", "properties": { "app": { "$ref": "#/definitions/AppWithChannels" } } } }, "getChannelAdoptionReportResponse": { "description": "GetChannelAdoptionReportResponse represents channel adoption report.", "schema": { "type": "object", "properties": { "report": { "type": "array", "items": { "$ref": "#/definitions/VersionAdoptionReport" }, "x-go-name": "Report" } } } }, "getChannelInstanceTrendsResponse": { "description": "GetChannelInstanceTrendsResponse represents a customer.", "schema": { "type": "object", "properties": { "instanceTrends": { "$ref": "#/definitions/InstanceTrends" } } } }, "getChannelResponse": { "description": "GetChannelResponse represents a channel.", "schema": { "type": "object", "properties": { "channel": { "$ref": "#/definitions/Channel" } } } }, "getCustomerEntitlementsResponse": { "description": "GetCustomerEntitlementsResponse represents a customer.", "schema": { "type": "object", "properties": { "entitlements": { "type": "array", "items": { "$ref": "#/definitions/EntitlementValue" }, "x-go-name": "Entitlements" } } } }, "getCustomerResponse": { "description": "GetCustomerResponse represents a customer.", "schema": { "type": "object", "properties": { "customer": { "$ref": "#/definitions/Customer" } } } }, "getHeritageEOLNoticeResponse": { "description": "GetHeritageEOLNoticeResponse represents heritage EOL notice metrics for the authenticated user.", "schema": { "type": "object", "properties": { "kubernetes": { "$ref": "#/definitions/HeritageAppUsage" }, "native": { "$ref": "#/definitions/HeritageAppUsage" }, "showWarning": { "type": "boolean", "x-go-name": "ShowWarning" }, "swarm": { "$ref": "#/definitions/HeritageAppUsage" } } } }, "listAppCustomersCsvResponse": { "description": "ListAppCustomersCsvResponse contains the list of customers", "headers": { "ContentDisposition": { "type": "string", "description": "Required: true\nIn: header" } } }, "listAppsResponse": { "description": "ListAppsResponse contains the JSON apps list", "schema": { "type": "object", "properties": { "apps": { "type": "array", "items": { "$ref": "#/definitions/AppWithChannels" }, "x-go-name": "Apps" } } } }, "listChannelsResponse": { "description": "ListChannelsResponse contains the JSON channels list", "schema": { "type": "object", "properties": { "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" }, "x-go-name": "Channels" }, "enterprise_channels": { "type": "array", "items": { "$ref": "#/definitions/EnterpriseChannel" }, "x-go-name": "EnterpriseChannels" } } } }, "listCustomHostnamesResponse": { "description": "ListCustomHostnamesResponse contains the JSON custom hostnames list", "schema": { "type": "object", "properties": { "download_portal": { "type": "array", "items": { "$ref": "#/definitions/CustomHostname" }, "x-go-name": "DownloadPortal" }, "proxy": { "type": "array", "items": { "$ref": "#/definitions/CustomHostname" }, "x-go-name": "Proxy" }, "registry": { "type": "array", "items": { "$ref": "#/definitions/CustomHostname" }, "x-go-name": "Registry" } } } }, "listCustomerInstancesResponse": { "description": "ListCustomerInstancesResponse contains the JSON instances list", "schema": { "type": "object", "properties": { "instances": { "type": "array", "items": { "$ref": "#/definitions/CustomerInstance" }, "x-go-name": "Instances" } } } }, "listCustomersResponse": { "description": "ListCustomersResponse contains the JSON customers list", "schema": { "type": "object", "properties": { "customers": { "type": "array", "items": { "$ref": "#/definitions/Customer" }, "x-go-name": "Customers" }, "totalCustomers": { "type": "integer", "format": "int64", "x-go-name": "TotalCustomers" } } } }, "listExternalRegistriesResponse": { "description": "ListExternalRegistriesResponse contains the JSON external registries list", "schema": { "type": "object", "properties": { "external_registries": { "type": "array", "items": { "$ref": "#/definitions/ExternalRegistry" }, "x-go-name": "ExternalRegistries" } } } }, "listLicenseFieldsResponse": { "description": "ListLicenseFieldsResponse contains the list of license fields", "schema": { "type": "array", "items": { "$ref": "#/definitions/EntitlementField" } } }, "postAirgapPasswordResponse": { "description": "PostAirgapPasswordResponse contains the returned password", "schema": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string", "x-go-name": "Password" } } } }, "responseErrBadRequest": { "description": "Returned on bad input" }, "responseErrConflict": { "description": "Returned on a conflict" }, "responseErrForbidden": { "description": "Returned if the caller does not have the needed permission" }, "responseErrNotFound": { "description": "Returned on resource not found" }, "responseErrUnauthorized": { "description": "Return if the caller is not authorized" }, "responseNoContent": { "description": "On success, no payload returned" }, "responseOk": { "description": "On success" }, "searchTeamCustomersResponse": { "description": "SearchTeamCustomersResponse contains the list of licenses", "schema": { "type": "object", "properties": { "customers": { "type": "array", "items": { "$ref": "#/definitions/Customer" }, "x-go-name": "Customers" }, "query": { "type": "string", "x-go-name": "Query" }, "total_hits": { "type": "integer", "format": "int64", "x-go-name": "TotalHits" } } } }, "setDefaultHostnameResponse": { "description": "SetDefaultHostnameResponse contains whether or not the request was successful", "schema": { "type": "object", "properties": { "success": { "type": "boolean", "x-go-name": "Success" } } } }, "testExternalRegistryResponse": { "description": "TestExternalRegistriesResponse contains the JSON external registries test", "schema": { "type": "object", "properties": { "error": { "type": "string", "x-go-name": "Error" }, "status": { "type": "integer", "format": "int64", "x-go-name": "Status" } } } }, "updateChannelRelease": { "description": "UpdateChannelReleaseResponse contains the release properties", "schema": { "type": "object", "properties": { "release": { "$ref": "#/definitions/KotsChannelRelease" } } } } }, "securityDefinitions": { "api_key": { "type": "apiKey", "name": "Authorization", "in": "header" } } }