{
  "swagger": "2.0",
  "info": {
    "title": "Octopus Server API",
    "version": "2026.3.13951"
  },
  "host": "demo.octopus.app",
  "basePath": "/api",
  "schemes": [
    "https"
  ],
  "paths": {
    "/users/access-token": {
      "post": {
        "tags": [
          "AccessTokens"
        ],
        "summary": "Create an access token for the current user",
        "operationId": "generateAccessToken",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Contains the created access token.",
            "schema": {
              "$ref": "#/definitions/GenerateAccessTokenResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/accounts": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get a list of accounts.",
        "description": "Lists accounts in the supplied Octopus Deploy Space in pages. The results will be sorted alphabetically by name.",
        "operationId": "getAccounts_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "accountType",
            "description": "The type of accounts to return.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of an Account to be matched.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial account name used for a sub-string search.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Accounts",
            "schema": {
              "$ref": "#/definitions/AccountResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Accounts"
        ],
        "summary": "Create a new account - of the type defined by body content",
        "operationId": "createAccount_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateAccountCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/AccountResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/accounts/all": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get a list of Accounts",
        "description": "Lists all of the accounts in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllAccounts_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested list of Accounts",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/AccountResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/accounts/azureenvironments": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List the Azure Environments provided by the SDK",
        "description": "List the Azure Environments provided by the SDK",
        "operationId": "getAzureEnvironmentsList",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/accounts/{accountId}": {
      "put": {
        "tags": [
          "Accounts"
        ],
        "summary": "Modify the account identified by the accoutId",
        "operationId": "modifyAccount_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "accountId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyAccountCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The resource returned from modifying an account",
            "schema": {
              "$ref": "#/definitions/AccountResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/accounts/{id}": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get an Account by ID",
        "operationId": "getAccountById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the account",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Account",
            "schema": {
              "$ref": "#/definitions/AccountResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Accounts"
        ],
        "summary": "Delete an existing Account",
        "operationId": "deleteAccount_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Account to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/accounts/{id}/pk": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Retrieve the public key portion of the account's associated certificate, if present.",
        "operationId": "getAccountCertificate_LegacyDefaultSpace",
        "produces": [
          "application/x-x509-ca-cert",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the account",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/accounts/{id}/resourceGroups": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List the Resource Groups associated with an Azure account.",
        "description": "List the Resource Groups associated with an Azure account.",
        "operationId": "getAzureResourceGroupsList_LegacyDefaultSpace",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/accounts/{id}/storageAccounts": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List the storage accounts associated with an Azure account.",
        "description": "List the storage accounts associated with an Azure account.",
        "operationId": "getAzureStorageAccountsList_LegacyDefaultSpace",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/accounts/{id}/usages": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List projects and deployments which are using an account.",
        "operationId": "getAccountUsage_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the account",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The projects and deployments which are using an account.",
            "schema": {
              "$ref": "#/definitions/AccountUsageResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/accounts/{id}/v1": {
      "delete": {
        "tags": [
          "Accounts"
        ],
        "summary": "Delete an existing Account",
        "operationId": "deleteAccountV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Account to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Account was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteAccountResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/accounts/{id}/websites": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List the websites associated with an Azure account.",
        "description": "List the websites associated with an Azure account.",
        "operationId": "getAzureWebSitesList_LegacyDefaultSpace",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/accounts/{id}/{resourceGroupName}/websites/{webSiteName}/slots": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List the slots associated with an Azure Web Site.",
        "description": "List the slots associated with an Azure Web Site.",
        "operationId": "getAzureWebSitesSlotList_LegacyDefaultSpace",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "resourceGroupName",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "webSiteName",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/accounttypes": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get the account types this Octopus Server supports",
        "description": "Lists the account types contributed by the extensions installed on this Server, sorted by name.",
        "operationId": "getAccountTypes",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The account types this Octopus Server supports",
            "schema": {
              "$ref": "#/definitions/GetAccountTypesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/accounts": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get a list of accounts.",
        "description": "Lists accounts in the supplied Octopus Deploy Space in pages. The results will be sorted alphabetically by name.",
        "operationId": "getAccountsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "accountType",
            "description": "The type of accounts to return.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of an Account to be matched.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial account name used for a sub-string search.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Accounts",
            "schema": {
              "$ref": "#/definitions/AccountResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Accounts"
        ],
        "summary": "Create a new account - of the type defined by body content",
        "operationId": "createAccountBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateAccountCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/AccountResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/accounts/all": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get a list of Accounts",
        "description": "Lists all of the accounts in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllAccountsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Accounts",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/AccountResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/accounts/{accountId}": {
      "put": {
        "tags": [
          "Accounts"
        ],
        "summary": "Modify the account identified by the accoutId",
        "operationId": "modifyAccountBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "accountId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyAccountCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The resource returned from modifying an account",
            "schema": {
              "$ref": "#/definitions/AccountResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/accounts/{id}": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get an Account by ID",
        "operationId": "getAccountByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the account",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Account",
            "schema": {
              "$ref": "#/definitions/AccountResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Accounts"
        ],
        "summary": "Delete an existing Account",
        "operationId": "deleteAccountBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Account to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/accounts/{id}/pk": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Retrieve the public key portion of the account's associated certificate, if present.",
        "operationId": "getAccountCertificateBySpace",
        "produces": [
          "application/x-x509-ca-cert",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the account",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/accounts/{id}/resourceGroups": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List the Resource Groups associated with an Azure account.",
        "description": "List the Resource Groups associated with an Azure account.",
        "operationId": "getAzureResourceGroupsListBySpace",
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/{spaceId}/accounts/{id}/storageAccounts": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List the storage accounts associated with an Azure account.",
        "description": "List the storage accounts associated with an Azure account.",
        "operationId": "getAzureStorageAccountsListBySpace",
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/{spaceId}/accounts/{id}/usages": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List projects and deployments which are using an account.",
        "operationId": "getAccountUsageBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the account",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The projects and deployments which are using an account.",
            "schema": {
              "$ref": "#/definitions/AccountUsageResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/accounts/{id}/v1": {
      "delete": {
        "tags": [
          "Accounts"
        ],
        "summary": "Delete an existing Account",
        "operationId": "deleteAccountV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Account to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Account was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteAccountResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/accounts/{id}/websites": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List the websites associated with an Azure account.",
        "description": "List the websites associated with an Azure account.",
        "operationId": "getAzureWebSitesListBySpace",
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/{spaceId}/accounts/{id}/{resourceGroupName}/websites/{webSiteName}/slots": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List the slots associated with an Azure Web Site.",
        "description": "List the slots associated with an Azure Web Site.",
        "operationId": "getAzureWebSitesSlotListBySpace",
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "resourceGroupName",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "webSiteName",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/accounts": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get a list of accounts.",
        "description": "Lists accounts in the supplied Octopus Deploy Space in pages. The results will be sorted alphabetically by name.",
        "operationId": "getAccounts",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "accountType",
            "description": "The type of accounts to return.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of an Account to be matched.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial account name used for a sub-string search.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Accounts",
            "schema": {
              "$ref": "#/definitions/AccountResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Accounts"
        ],
        "summary": "Create a new account - of the type defined by body content",
        "operationId": "createAccount",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateAccountCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/AccountResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/accounts/all": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get a list of Accounts",
        "description": "Lists all of the accounts in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllAccounts",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Accounts",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/AccountResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/accounts/{accountId}": {
      "put": {
        "tags": [
          "Accounts"
        ],
        "summary": "Modify the account identified by the accoutId",
        "operationId": "modifyAccount",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "accountId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyAccountCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The resource returned from modifying an account",
            "schema": {
              "$ref": "#/definitions/AccountResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/accounts/{id}": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get an Account by ID",
        "operationId": "getAccountById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the account",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Account",
            "schema": {
              "$ref": "#/definitions/AccountResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Accounts"
        ],
        "summary": "Delete an existing Account",
        "operationId": "deleteAccount",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Account to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/accounts/{id}/pk": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Retrieve the public key portion of the account's associated certificate, if present.",
        "operationId": "getAccountCertificate",
        "produces": [
          "application/x-x509-ca-cert",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the account",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/accounts/{id}/resourceGroups": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List the Resource Groups associated with an Azure account.",
        "description": "List the Resource Groups associated with an Azure account.",
        "operationId": "getAzureResourceGroupsList",
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/accounts/{id}/storageAccounts": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List the storage accounts associated with an Azure account.",
        "description": "List the storage accounts associated with an Azure account.",
        "operationId": "getAzureStorageAccountsList",
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/accounts/{id}/usages": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List projects and deployments which are using an account.",
        "operationId": "getAccountUsage",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the account",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The projects and deployments which are using an account.",
            "schema": {
              "$ref": "#/definitions/AccountUsageResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/accounts/{id}/v1": {
      "delete": {
        "tags": [
          "Accounts"
        ],
        "summary": "Delete an existing Account",
        "operationId": "deleteAccountV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Account to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Account was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteAccountResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/accounts/{id}/websites": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List the websites associated with an Azure account.",
        "description": "List the websites associated with an Azure account.",
        "operationId": "getAzureWebSitesList",
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/accounts/{id}/{resourceGroupName}/websites/{webSiteName}/slots": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "List the slots associated with an Azure Web Site.",
        "description": "List the slots associated with an Azure Web Site.",
        "operationId": "getAzureWebSitesSlotList",
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "resourceGroupName",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "webSiteName",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/actiontemplates": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get a list of Action Templates",
        "description": "Lists all of the Action Templates in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getActionTemplates_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "IDs of the action templates to fetch.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isCommunityActionTemplate",
            "description": "Filters the results based on whether the action is a community template.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \\\"contains\\\" style match against the supplied name or name-fragment.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Templates",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Create an Action Template.",
        "operationId": "createActionTemplate_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateActionTemplateCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actiontemplates/all": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get all Action Templates",
        "description": "Lists the all of the action templates in the supplied Octopus Deploy Space. The results will be sorted by name.",
        "operationId": "getAllActionTemplates_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested Action Templates",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actiontemplates/categories": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get a list of Action Template categories",
        "operationId": "getActionTemplateCategories_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested Action Template categories",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateCategoryResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actiontemplates/search": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "List all available action templates including built-in, custom and community contributed step templates.",
        "description": "Lists all of the Action Templates in the supplied Octopus Deploy Space that fit the search criteria.",
        "operationId": "searchActionTemplates_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "type",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The found Action Templates",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateSearchResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actiontemplates/{id}": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get an Action Template by ID",
        "operationId": "getActionTemplateById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ActionTemplate to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Template",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Modify an existing action template.",
        "operationId": "modifyActionTemplate_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the existing Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyActionTemplateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Action Template was modified, including the updated template.",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actionTemplates/{id}": {
      "delete": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Delete an existing Action Template and all its versions.",
        "operationId": "deleteActionTemplateById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Action Template to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actiontemplates/{id}/actionsUpdate": {
      "post": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Update deployment and runbook actions to a specific version of the action template",
        "operationId": "updateActionTemplateActions_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/UpdateActionTemplateActionsCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "ActionUpdateResultResources with details of the results of the update returned",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionUpdateResultResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actiontemplates/{id}/actionsUpdate/bulk": {
      "post": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Create a server task to update deployment and runbook actions to a specific version of the action template",
        "operationId": "bulkUpdateActionTemplateActions_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BulkUpdateActionTemplateActionsCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the results of the update of the actions updated to match the action template.",
            "schema": {
              "$ref": "#/definitions/BulkUpdateActionTemplateActionsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actiontemplates/{id}/logo": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get the logo associated with the latest version of action template.",
        "operationId": "getActionTemplateLogo_LegacyDefaultSpace",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Action Type or ID of the action type logo",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Update the logo associated with the latest version of the action template.",
        "operationId": "modifyActionTemplateLogo_LegacyDefaultSpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the action template for which to set the logo",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the logo was updated",
            "schema": {
              "$ref": "#/definitions/ModifyActionTemplateLogoResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Update the logo associated with the latest version of the action template.",
        "operationId": "modifyActionTemplateLogoUsingPut_LegacyDefaultSpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the action template for which to set the logo",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the logo was updated",
            "schema": {
              "$ref": "#/definitions/ModifyActionTemplateLogoResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actiontemplates/{id}/usage": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get usages for an Action Template.",
        "description": "Gets a list of all steps/deployment processes that use a given action template.",
        "operationId": "getActionTemplateUsages_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the resource",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "branch",
            "description": "Optionally filter usages associated with a config as code branch",
            "type": "string"
          },
          {
            "in": "query",
            "name": "process",
            "description": "Optionally filter by process type",
            "type": "string",
            "enum": [
              "Deployment",
              "Runbook"
            ]
          },
          {
            "in": "query",
            "name": "project",
            "description": "Optionally filter version controlled usages by project",
            "type": "string"
          },
          {
            "in": "query",
            "name": "withUpdates",
            "description": "Optionally filter for only version controlled usages with updates",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Template usages",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateUsageResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actiontemplates/{id}/v1": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get an Action Template by ID",
        "operationId": "getActionTemplateByIdV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ActionTemplate to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Template",
            "schema": {
              "$ref": "#/definitions/GetActionTemplateByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actionTemplates/{id}/v1": {
      "delete": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Delete an existing Action Template and all its versions.",
        "operationId": "deleteActionTemplateByIdV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Action Template to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the requested Action Template has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteActionTemplateByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actiontemplates/{id}/versions": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get all versions of an Action Template.",
        "operationId": "getAllActionTemplateVersions_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Action Template.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of action template resources for each version.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actiontemplates/{id}/versions/{version}": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get a specific version of an Action Template.",
        "operationId": "getActionTemplateVersion_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "version",
            "description": "The version number of the Action Template.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The action template resource.",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/actiontemplates/{typeOrId}/versions/{version}/logo": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get the logo associated with specific version of the action template.",
        "operationId": "getActionTemplateVersionLogo_LegacyDefaultSpace",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "typeOrId",
            "description": "Action Type or ID of the action type logo",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "version",
            "description": "Version of the action type logo",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actiontemplates": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get a list of Action Templates",
        "description": "Lists all of the Action Templates in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getActionTemplatesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "IDs of the action templates to fetch.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isCommunityActionTemplate",
            "description": "Filters the results based on whether the action is a community template.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \\\"contains\\\" style match against the supplied name or name-fragment.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Templates",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Create an Action Template.",
        "operationId": "createActionTemplateBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the Space that contains the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateActionTemplateCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actiontemplates/all": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get all Action Templates",
        "description": "Lists the all of the action templates in the supplied Octopus Deploy Space. The results will be sorted by name.",
        "operationId": "getAllActionTemplatesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Templates",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actiontemplates/categories": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get a list of Action Template categories",
        "operationId": "getActionTemplateCategoriesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Template categories",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateCategoryResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actiontemplates/search": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "List all available action templates including built-in, custom and community contributed step templates.",
        "description": "Lists all of the Action Templates in the supplied Octopus Deploy Space that fit the search criteria.",
        "operationId": "searchActionTemplatesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "type",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The found Action Templates",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateSearchResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actiontemplates/{id}": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get an Action Template by ID",
        "operationId": "getActionTemplateByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ActionTemplate to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Template",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Modify an existing action template.",
        "operationId": "modifyActionTemplateBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the Space that contains the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the existing Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyActionTemplateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Action Template was modified, including the updated template.",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actionTemplates/{id}": {
      "delete": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Delete an existing Action Template and all its versions.",
        "operationId": "deleteActionTemplateByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Action Template to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actiontemplates/{id}/actionsUpdate": {
      "post": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Update deployment and runbook actions to a specific version of the action template",
        "operationId": "updateActionTemplateActionsBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the Space containing the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/UpdateActionTemplateActionsCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "ActionUpdateResultResources with details of the results of the update returned",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionUpdateResultResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actiontemplates/{id}/actionsUpdate/bulk": {
      "post": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Create a server task to update deployment and runbook actions to a specific version of the action template",
        "operationId": "bulkUpdateActionTemplateActionsBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the Space containing the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BulkUpdateActionTemplateActionsCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the results of the update of the actions updated to match the action template.",
            "schema": {
              "$ref": "#/definitions/BulkUpdateActionTemplateActionsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actiontemplates/{id}/logo": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get the logo associated with the latest version of action template.",
        "operationId": "getActionTemplateLogoBySpace",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Action Type or ID of the action type logo",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Update the logo associated with the latest version of the action template.",
        "operationId": "modifyActionTemplateLogoBySpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the action template for which to set the logo",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the logo was updated",
            "schema": {
              "$ref": "#/definitions/ModifyActionTemplateLogoResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Update the logo associated with the latest version of the action template.",
        "operationId": "modifyActionTemplateLogoBySpaceUsingPut",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the action template for which to set the logo",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the logo was updated",
            "schema": {
              "$ref": "#/definitions/ModifyActionTemplateLogoResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actiontemplates/{id}/usage": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get usages for an Action Template.",
        "description": "Gets a list of all steps/deployment processes that use a given action template.",
        "operationId": "getActionTemplateUsagesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the resource",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "branch",
            "description": "Optionally filter usages associated with a config as code branch",
            "type": "string"
          },
          {
            "in": "query",
            "name": "process",
            "description": "Optionally filter by process type",
            "type": "string",
            "enum": [
              "Deployment",
              "Runbook"
            ]
          },
          {
            "in": "query",
            "name": "project",
            "description": "Optionally filter version controlled usages by project",
            "type": "string"
          },
          {
            "in": "query",
            "name": "withUpdates",
            "description": "Optionally filter for only version controlled usages with updates",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Template usages",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateUsageResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actiontemplates/{id}/v1": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get an Action Template by ID",
        "operationId": "getActionTemplateByIdV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ActionTemplate to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Template",
            "schema": {
              "$ref": "#/definitions/GetActionTemplateByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actionTemplates/{id}/v1": {
      "delete": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Delete an existing Action Template and all its versions.",
        "operationId": "deleteActionTemplateByIdV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Action Template to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the requested Action Template has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteActionTemplateByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actiontemplates/{id}/versions": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get all versions of an Action Template.",
        "operationId": "getAllActionTemplateVersionsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the Space that contains the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Action Template.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of action template resources for each version.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actiontemplates/{id}/versions/{version}": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get a specific version of an Action Template.",
        "operationId": "getActionTemplateVersionBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the Space that contains the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "version",
            "description": "The version number of the Action Template.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The action template resource.",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/actiontemplates/{typeOrId}/versions/{version}/logo": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get the logo associated with specific version of the action template.",
        "operationId": "getActionTemplateVersionLogoBySpace",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "typeOrId",
            "description": "Action Type or ID of the action type logo",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "version",
            "description": "Version of the action type logo",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actiontemplates": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get a list of Action Templates",
        "description": "Lists all of the Action Templates in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getActionTemplates",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "IDs of the action templates to fetch.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isCommunityActionTemplate",
            "description": "Filters the results based on whether the action is a community template.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \\\"contains\\\" style match against the supplied name or name-fragment.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Templates",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Create an Action Template.",
        "operationId": "createActionTemplate",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateActionTemplateCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actiontemplates/all": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get all Action Templates",
        "description": "Lists the all of the action templates in the supplied Octopus Deploy Space. The results will be sorted by name.",
        "operationId": "getAllActionTemplates",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Templates",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actiontemplates/categories": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get a list of Action Template categories",
        "operationId": "getActionTemplateCategories",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Template categories",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateCategoryResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actiontemplates/search": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "List all available action templates including built-in, custom and community contributed step templates.",
        "description": "Lists all of the Action Templates in the supplied Octopus Deploy Space that fit the search criteria.",
        "operationId": "searchActionTemplates",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "type",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The found Action Templates",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateSearchResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actiontemplates/{id}": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get an Action Template by ID",
        "operationId": "getActionTemplateById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ActionTemplate to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Template",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Modify an existing action template.",
        "operationId": "modifyActionTemplate",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the existing Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyActionTemplateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Action Template was modified, including the updated template.",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actionTemplates/{id}": {
      "delete": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Delete an existing Action Template and all its versions.",
        "operationId": "deleteActionTemplateById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Action Template to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actiontemplates/{id}/actionsUpdate": {
      "post": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Update deployment and runbook actions to a specific version of the action template",
        "operationId": "updateActionTemplateActions",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/UpdateActionTemplateActionsCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "ActionUpdateResultResources with details of the results of the update returned",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionUpdateResultResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actiontemplates/{id}/actionsUpdate/bulk": {
      "post": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Create a server task to update deployment and runbook actions to a specific version of the action template",
        "operationId": "bulkUpdateActionTemplateActions",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BulkUpdateActionTemplateActionsCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the results of the update of the actions updated to match the action template.",
            "schema": {
              "$ref": "#/definitions/BulkUpdateActionTemplateActionsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actiontemplates/{id}/logo": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get the logo associated with the latest version of action template.",
        "operationId": "getActionTemplateLogo",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Action Type or ID of the action type logo",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Update the logo associated with the latest version of the action template.",
        "operationId": "modifyActionTemplateLogo",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the action template for which to set the logo",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the logo was updated",
            "schema": {
              "$ref": "#/definitions/ModifyActionTemplateLogoResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Update the logo associated with the latest version of the action template.",
        "operationId": "modifyActionTemplateLogoUsingPut",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the action template for which to set the logo",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the logo was updated",
            "schema": {
              "$ref": "#/definitions/ModifyActionTemplateLogoResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actiontemplates/{id}/usage": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get usages for an Action Template.",
        "description": "Gets a list of all steps/deployment processes that use a given action template.",
        "operationId": "getActionTemplateUsages",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the resource",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "branch",
            "description": "Optionally filter usages associated with a config as code branch",
            "type": "string"
          },
          {
            "in": "query",
            "name": "process",
            "description": "Optionally filter by process type",
            "type": "string",
            "enum": [
              "Deployment",
              "Runbook"
            ]
          },
          {
            "in": "query",
            "name": "project",
            "description": "Optionally filter version controlled usages by project",
            "type": "string"
          },
          {
            "in": "query",
            "name": "withUpdates",
            "description": "Optionally filter for only version controlled usages with updates",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Template usages",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateUsageResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actiontemplates/{id}/v1": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get an Action Template by ID",
        "operationId": "getActionTemplateByIdV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ActionTemplate to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Action Template",
            "schema": {
              "$ref": "#/definitions/GetActionTemplateByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actionTemplates/{id}/v1": {
      "delete": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Delete an existing Action Template and all its versions.",
        "operationId": "deleteActionTemplateByIdV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Action Template to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the requested Action Template has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteActionTemplateByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actiontemplates/{id}/versions": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get all versions of an Action Template.",
        "operationId": "getAllActionTemplateVersions",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Action Template.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of action template resources for each version.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActionTemplateResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actiontemplates/{id}/versions/{version}": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get a specific version of an Action Template.",
        "operationId": "getActionTemplateVersion",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "version",
            "description": "The version number of the Action Template.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The action template resource.",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/actiontemplates/{typeOrId}/versions/{version}/logo": {
      "get": {
        "tags": [
          "ActionTemplates"
        ],
        "summary": "Get the logo associated with specific version of the action template.",
        "operationId": "getActionTemplateVersionLogo",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "typeOrId",
            "description": "Action Type or ID of the action type logo",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "version",
            "description": "Version of the action type logo",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/{userId}/apikeys": {
      "get": {
        "tags": [
          "ApiKeys"
        ],
        "summary": "Get a list of API Keys for a User",
        "description": "Lists all API keys for a user, returning the most recent results first.",
        "operationId": "getUserApiKeys",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "userId",
            "description": "ID of the User",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialKeyword",
            "description": "Optional case-insensitive filter on the API key purpose or hint.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialPurpose",
            "description": "Optional case-insensitive filter on the API key purpose.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ApiKeyResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ApiKeys"
        ],
        "summary": "Generate a new API key for a User",
        "description": "The API Key returned in the result must be saved by the caller, as it cannot be retrieved subsequently from the Octopus server",
        "operationId": "createUserApiKey",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "userId",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateUserApiKeyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The created API Key, containing the unencrypted value of the key which must be saved by the caller, as it cannot be retrieved subsequently from the Octopus server.",
            "schema": {
              "$ref": "#/definitions/ApiKeyCreatedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/{userId}/apikeys/v1": {
      "get": {
        "tags": [
          "ApiKeys"
        ],
        "summary": "Get a list of API Keys for a User",
        "description": "Lists all API keys for a user, returning the most recent results first.",
        "operationId": "getUserApiKeysV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "userId",
            "description": "ID of the User",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialKeyword",
            "description": "Optional case-insensitive filter on the API key purpose or hint.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialPurpose",
            "description": "Optional case-insensitive filter on the API key purpose.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetUserApiKeysResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/{userId}/apikeys/{id}": {
      "get": {
        "tags": [
          "ApiKeys"
        ],
        "summary": "Get an API Key by ID",
        "operationId": "getUserApiKeyById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "userId",
            "description": "ID of the User that owns the ApiKey",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ApiKeyResource to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested API Key",
            "schema": {
              "$ref": "#/definitions/ApiKeyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ApiKeys"
        ],
        "summary": "Revoke an API Key",
        "operationId": "deleteUserApiKeyById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "userId",
            "description": "Id of the User that owns the ApiKey to delete.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the ApiKey to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that a User API Key has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteUserApiKeyByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/approvalrules": {
      "get": {
        "tags": [
          "ApprovalRules"
        ],
        "summary": "Get a list of Approval rules",
        "description": "Lists all of the approval rules in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "listApprovalRulesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ApprovalRuleResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ApprovalRules"
        ],
        "summary": "Creates a new approval rule in the specified Octopus Deploy space.",
        "operationId": "createApprovalRuleBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateApprovalRuleCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ApprovalRuleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/approvalrules/{id}": {
      "get": {
        "tags": [
          "ApprovalRules"
        ],
        "summary": "Gets an ApprovalRuleResource by ID",
        "description": "Gets an ApprovalRule by ID.",
        "operationId": "getApprovalRuleByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the approval rule.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ApprovalRuleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ApprovalRules"
        ],
        "summary": "Modifies an existing approval rule in the specified Octopus Deploy space.",
        "operationId": "modifyApprovalRuleBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyApprovalRuleCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ApprovalRuleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ApprovalRules"
        ],
        "summary": "Deletes an existing ApprovalRule",
        "operationId": "deleteApprovalRuleBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the ApprovalRule.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the ApprovalRule.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response to deleting a ApprovalRule",
            "schema": {
              "$ref": "#/definitions/DeleteApprovalRuleResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/approvalrules": {
      "get": {
        "tags": [
          "ApprovalRules"
        ],
        "summary": "Get a list of Approval rules",
        "description": "Lists all of the approval rules in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "listApprovalRules",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ApprovalRuleResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ApprovalRules"
        ],
        "summary": "Creates a new approval rule in the specified Octopus Deploy space.",
        "operationId": "createApprovalRule",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateApprovalRuleCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ApprovalRuleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/approvalrules/{id}": {
      "get": {
        "tags": [
          "ApprovalRules"
        ],
        "summary": "Gets an ApprovalRuleResource by ID",
        "description": "Gets an ApprovalRule by ID.",
        "operationId": "getApprovalRuleById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the approval rule.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ApprovalRuleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ApprovalRules"
        ],
        "summary": "Modifies an existing approval rule in the specified Octopus Deploy space.",
        "operationId": "modifyApprovalRule",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyApprovalRuleCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ApprovalRuleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ApprovalRules"
        ],
        "summary": "Deletes an existing ApprovalRule",
        "operationId": "deleteApprovalRule",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the ApprovalRule.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response to deleting a ApprovalRule",
            "schema": {
              "$ref": "#/definitions/DeleteApprovalRuleResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/servertaskapprovals/{serverTaskApprovalId}/approvals": {
      "get": {
        "tags": [
          "Approvals"
        ],
        "summary": "Get a list of all approvals for a server task approval",
        "operationId": "listApprovalsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the server task approval.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "serverTaskApprovalId",
            "description": "The id of the Server Task Approval.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ApprovalResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Approvals"
        ],
        "summary": "Create a new Approval",
        "operationId": "createApprovalBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the Approval.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "serverTaskApprovalId",
            "description": "The Server Task Approval id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateApprovalCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ApprovalResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/servertaskapprovals/{serverTaskApprovalId}/approvals/{id}": {
      "get": {
        "tags": [
          "Approvals"
        ],
        "summary": "Get an Approval by id",
        "operationId": "getApprovalByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the Approval.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "serverTaskApprovalId",
            "description": "The id of the Server Task Approval.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Approval.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ApprovalResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Approvals"
        ],
        "summary": "Modify an Approval",
        "operationId": "modifyApprovalBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the Approval.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "serverTaskApprovalId",
            "description": "The id of the Server Task Approval.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Approval.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyApprovalCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ApprovalResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/servertaskapprovals/{serverTaskApprovalId}/approvals": {
      "get": {
        "tags": [
          "Approvals"
        ],
        "summary": "Get a list of all approvals for a server task approval",
        "operationId": "listApprovals",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "serverTaskApprovalId",
            "description": "The id of the Server Task Approval.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ApprovalResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Approvals"
        ],
        "summary": "Create a new Approval",
        "operationId": "createApproval",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "serverTaskApprovalId",
            "description": "The Server Task Approval id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateApprovalCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ApprovalResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/servertaskapprovals/{serverTaskApprovalId}/approvals/{id}": {
      "get": {
        "tags": [
          "Approvals"
        ],
        "summary": "Get an Approval by id",
        "operationId": "getApprovalById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "serverTaskApprovalId",
            "description": "The id of the Server Task Approval.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Approval.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ApprovalResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Approvals"
        ],
        "summary": "Modify an Approval",
        "operationId": "modifyApproval",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "serverTaskApprovalId",
            "description": "The id of the Server Task Approval.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Approval.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyApprovalCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ApprovalResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/artifacts": {
      "get": {
        "tags": [
          "Artifacts"
        ],
        "summary": "List all of the artifacts in the supplied Octopus Deploy Space, from all releases. The results will be sorted by date from most recently to least recently created.",
        "operationId": "getArtifacts_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "List of Artifact IDs which if specified, filters the result to only include Artifacts with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "order",
            "description": "asc or desc",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "regarding",
            "description": "An ID of a resource to filter on. Only artifacts related to this resource will be returned. It can be the ID of the following: Release, RunbookSnapshot, Deployment, Runbook Run, Server Task, Project, Environment or Tenant.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of Artifacts",
            "schema": {
              "$ref": "#/definitions/ArtifactResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Create a new artifact.",
        "description": "Creates a new artifact.",
        "operationId": "createArtifact_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateArtifactCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ArtifactResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/artifacts/{id}": {
      "get": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Get an Artifact by ID",
        "operationId": "getArtifactById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Artifact to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Gets a specific Artifact",
            "schema": {
              "$ref": "#/definitions/ArtifactResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Modify an existing artifact.",
        "operationId": "modifyArtifact_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the artifact.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Artifacts are files like documents and test results that may be stored alongside a release.",
            "schema": {
              "$ref": "#/definitions/ArtifactResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Delete an existing Artifact",
        "operationId": "deleteArtifact_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Artifact to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/artifacts/{id}/content": {
      "get": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Get the content associated with an artifact.",
        "operationId": "getArtifactContent_LegacyDefaultSpace",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the artifact",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Artifacts"
        ],
        "description": "Sets the content associated with an artifact.",
        "operationId": "updateArtifactContent_LegacyDefaultSpace",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the artifact",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "204": {
            "description": "The content was successfully uploaded."
          }
        }
      }
    },
    "/{spaceId}/artifacts": {
      "get": {
        "tags": [
          "Artifacts"
        ],
        "summary": "List all of the artifacts in the supplied Octopus Deploy Space, from all releases. The results will be sorted by date from most recently to least recently created.",
        "operationId": "getArtifactsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Artifact IDs which if specified, filters the result to only include Artifacts with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "order",
            "description": "asc or desc",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "regarding",
            "description": "An ID of a resource to filter on. Only artifacts related to this resource will be returned. It can be the ID of the following: Release, RunbookSnapshot, Deployment, Runbook Run, Server Task, Project, Environment or Tenant.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of Artifacts",
            "schema": {
              "$ref": "#/definitions/ArtifactResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Create a new artifact.",
        "description": "Creates a new artifact.",
        "operationId": "createArtifactBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateArtifactCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ArtifactResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/artifacts/{id}": {
      "get": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Get an Artifact by ID",
        "operationId": "getArtifactByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Artifact to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Gets a specific Artifact",
            "schema": {
              "$ref": "#/definitions/ArtifactResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Modify an existing artifact.",
        "operationId": "modifyArtifactBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the artifact.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Artifacts are files like documents and test results that may be stored alongside a release.",
            "schema": {
              "$ref": "#/definitions/ArtifactResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Delete an existing Artifact",
        "operationId": "deleteArtifactBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Artifact to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/artifacts/{id}/content": {
      "get": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Get the content associated with an artifact.",
        "operationId": "getArtifactContentBySpace",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the artifact",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Artifacts"
        ],
        "description": "Sets the content associated with an artifact.",
        "operationId": "updateArtifactContentBySpace",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the artifact",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "204": {
            "description": "The content was successfully uploaded."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/artifacts": {
      "get": {
        "tags": [
          "Artifacts"
        ],
        "summary": "List all of the artifacts in the supplied Octopus Deploy Space, from all releases. The results will be sorted by date from most recently to least recently created.",
        "operationId": "getArtifacts",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Artifact IDs which if specified, filters the result to only include Artifacts with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "order",
            "description": "asc or desc",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "regarding",
            "description": "An ID of a resource to filter on. Only artifacts related to this resource will be returned. It can be the ID of the following: Release, RunbookSnapshot, Deployment, Runbook Run, Server Task, Project, Environment or Tenant.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of Artifacts",
            "schema": {
              "$ref": "#/definitions/ArtifactResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Create a new artifact.",
        "description": "Creates a new artifact.",
        "operationId": "createArtifact",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateArtifactCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ArtifactResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/artifacts/{id}": {
      "get": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Get an Artifact by ID",
        "operationId": "getArtifactById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Artifact to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Gets a specific Artifact",
            "schema": {
              "$ref": "#/definitions/ArtifactResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Modify an existing artifact.",
        "operationId": "modifyArtifact",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the artifact.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Artifacts are files like documents and test results that may be stored alongside a release.",
            "schema": {
              "$ref": "#/definitions/ArtifactResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Delete an existing Artifact",
        "operationId": "deleteArtifact",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Artifact to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/artifacts/{id}/content": {
      "get": {
        "tags": [
          "Artifacts"
        ],
        "summary": "Get the content associated with an artifact.",
        "operationId": "getArtifactContent",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the artifact",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Artifacts"
        ],
        "description": "Sets the content associated with an artifact.",
        "operationId": "updateArtifactContent",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the artifact",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "204": {
            "description": "The content was successfully uploaded."
          }
        }
      }
    },
    "/audit-stream": {
      "get": {
        "tags": [
          "AuditStream"
        ],
        "summary": "Get the audit stream configuration",
        "operationId": "getAuditStreamConfiguration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The Audit Stream configuration",
            "schema": {
              "$ref": "#/definitions/AuditStreamConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "AuditStream"
        ],
        "summary": "Modify the audit stream configuration",
        "operationId": "modifyAuditStreamConfiguration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "The desired state of the Audit Stream configuration",
            "schema": {
              "$ref": "#/definitions/ModifyAuditStreamConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified Audit Stream configuration",
            "schema": {
              "$ref": "#/definitions/AuditStreamConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/authentication": {
      "get": {
        "tags": [
          "Authentication"
        ],
        "summary": "Get authentication providers",
        "description": "Provides the details of the enabled authentication providers.",
        "operationId": "getAuthentication",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested Authentication Information",
            "schema": {
              "$ref": "#/definitions/AuthenticationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/authentication/checklogininitiated": {
      "post": {
        "tags": [
          "Authentication"
        ],
        "summary": "Determine whether an external server (.e.g Okta) has initiated login from a URL query string and, if so, get the provider's name",
        "operationId": "checkLoginInitiated",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CheckLoginInitiatedCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Whether the external server has initiated login and if so the provider's name",
            "schema": {
              "$ref": "#/definitions/LoginInitiatedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/azuredevopsissuetracker/connectivitycheck": {
      "post": {
        "tags": [
          "AzureDevOps"
        ],
        "operationId": "postAzureDevOpsConnectivityCheck",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/projects/{projectId}/git/branches": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Request the list of Branches for a given Project",
        "operationId": "getBranchesByProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Branches",
            "schema": {
              "$ref": "#/definitions/GitBranchResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/git/branches/v2": {
      "post": {
        "tags": [
          "Branches"
        ],
        "summary": "Create a branch given a project, the base git ref, and the new branch's name",
        "operationId": "createBranchV2_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateBranchCommandV2"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The newly-created Branch",
            "schema": {
              "$ref": "#/definitions/GitBranchResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/git/branches/{branchName}": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Get a Git branch by name",
        "description": "Gets a named version control branch for a project.",
        "operationId": "getBranchByName_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "branchName",
            "description": "Name of the branch",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Branch",
            "schema": {
              "$ref": "#/definitions/GitBranchResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/git/commits/{hash}": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Get a Git commit by hash",
        "description": "Gets a git commit for a project.",
        "operationId": "getCommitByHash_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "hash",
            "description": "Hash of the commit",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Commit",
            "schema": {
              "$ref": "#/definitions/GitCommitResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/git/refs/{refName}": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Get a Git named reference by name",
        "description": "Gets a named version control reference for a project.",
        "operationId": "getNamedRefByName_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "refName",
            "description": "Name of the git reference",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Named Git Reference",
            "schema": {
              "$ref": "#/definitions/GitNamedRefByNameResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/git/tags": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Request a list of Git Tags for the project",
        "operationId": "getTagsByProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Tags",
            "schema": {
              "$ref": "#/definitions/GitTagResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/git/tags/{tagName}": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Get an individual Git Tag; searching for it by Name",
        "operationId": "getTagByName_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tagName",
            "description": "Name of the tag",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Tag",
            "schema": {
              "$ref": "#/definitions/GitTagResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/git/branches": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Request the list of Branches for a given Project",
        "operationId": "getBranchesByProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Branches",
            "schema": {
              "$ref": "#/definitions/GitBranchResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/git/branches/v2": {
      "post": {
        "tags": [
          "Branches"
        ],
        "summary": "Create a branch given a project, the base git ref, and the new branch's name",
        "operationId": "createBranchV2BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateBranchCommandV2"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The newly-created Branch",
            "schema": {
              "$ref": "#/definitions/GitBranchResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/git/branches/{branchName}": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Get a Git branch by name",
        "description": "Gets a named version control branch for a project.",
        "operationId": "getBranchByNameBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "branchName",
            "description": "Name of the branch",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Branch",
            "schema": {
              "$ref": "#/definitions/GitBranchResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/git/commits/{hash}": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Get a Git commit by hash",
        "description": "Gets a git commit for a project.",
        "operationId": "getCommitByHashBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "hash",
            "description": "Hash of the commit",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Commit",
            "schema": {
              "$ref": "#/definitions/GitCommitResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/git/refs/{refName}": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Get a Git named reference by name",
        "description": "Gets a named version control reference for a project.",
        "operationId": "getNamedRefByNameBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "refName",
            "description": "Name of the git reference",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Named Git Reference",
            "schema": {
              "$ref": "#/definitions/GitNamedRefByNameResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/git/tags": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Request a list of Git Tags for the project",
        "operationId": "getTagsByProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Tags",
            "schema": {
              "$ref": "#/definitions/GitTagResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/git/tags/{tagName}": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Get an individual Git Tag; searching for it by Name",
        "operationId": "getTagByNameBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tagName",
            "description": "Name of the tag",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Tag",
            "schema": {
              "$ref": "#/definitions/GitTagResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/git/branches": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Request the list of Branches for a given Project",
        "operationId": "getBranchesByProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Branches",
            "schema": {
              "$ref": "#/definitions/GitBranchResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/git/branches/v2": {
      "post": {
        "tags": [
          "Branches"
        ],
        "summary": "Create a branch given a project, the base git ref, and the new branch's name",
        "operationId": "createBranchV2",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateBranchCommandV2"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The newly-created Branch",
            "schema": {
              "$ref": "#/definitions/GitBranchResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/git/branches/{branchName}": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Get a Git branch by name",
        "description": "Gets a named version control branch for a project.",
        "operationId": "getBranchByName",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "branchName",
            "description": "Name of the branch",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Branch",
            "schema": {
              "$ref": "#/definitions/GitBranchResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/git/commits/{hash}": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Get a Git commit by hash",
        "description": "Gets a git commit for a project.",
        "operationId": "getCommitByHash",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "hash",
            "description": "Hash of the commit",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Commit",
            "schema": {
              "$ref": "#/definitions/GitCommitResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/git/refs/{refName}": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Get a Git named reference by name",
        "description": "Gets a named version control reference for a project.",
        "operationId": "getNamedRefByName",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "refName",
            "description": "Name of the git reference",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Named Git Reference",
            "schema": {
              "$ref": "#/definitions/GitNamedRefByNameResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/git/tags": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Request a list of Git Tags for the project",
        "operationId": "getTagsByProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Tags",
            "schema": {
              "$ref": "#/definitions/GitTagResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/git/tags/{tagName}": {
      "get": {
        "tags": [
          "Branches"
        ],
        "summary": "Get an individual Git Tag; searching for it by Name",
        "operationId": "getTagByName",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tagName",
            "description": "Name of the tag",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Tag",
            "schema": {
              "$ref": "#/definitions/GitTagResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/build-information": {
      "get": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Retrieve a list of build information records describing the vcs information for a given package",
        "operationId": "getAllBuildInformation_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "filter",
            "description": "A version to look for.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeWorkItems",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "latest",
            "description": "If true, returns only the latest build information.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "packageId",
            "description": "An exact package to look for.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialPackageId",
            "description": "A partial package ID used for a sub-string search.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Build Information",
            "schema": {
              "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Create or update a specific build information record describing the vcs information for a given package",
        "operationId": "createBuildInformation_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateBuildInformationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Build information updated.",
            "schema": {
              "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResource"
            }
          },
          "201": {
            "description": "Build information created.",
            "schema": {
              "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/build-information/bulk": {
      "delete": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Bulk delete specific Build Information records.",
        "operationId": "bulkDeleteBuildInformation_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BulkDeleteBuildInformationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/build-information/{id}": {
      "get": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Retrieve a specific build information record describing the vcs information for a given package",
        "operationId": "getBuildInformationById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The build information id to retrieve.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Build Information",
            "schema": {
              "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Delete a specific Build Information record.",
        "operationId": "deleteBuildInformation_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Build Information to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/build-information": {
      "get": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Retrieve a list of build information records describing the vcs information for a given package",
        "operationId": "getAllBuildInformationBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "A version to look for.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeWorkItems",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "latest",
            "description": "If true, returns only the latest build information.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "packageId",
            "description": "An exact package to look for.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialPackageId",
            "description": "A partial package ID used for a sub-string search.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Build Information",
            "schema": {
              "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Create or update a specific build information record describing the vcs information for a given package",
        "operationId": "createBuildInformationBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateBuildInformationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Build information updated.",
            "schema": {
              "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResource"
            }
          },
          "201": {
            "description": "Build information created.",
            "schema": {
              "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/build-information/bulk": {
      "delete": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Bulk delete specific Build Information records.",
        "operationId": "bulkDeleteBuildInformationBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BulkDeleteBuildInformationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/build-information/{id}": {
      "get": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Retrieve a specific build information record describing the vcs information for a given package",
        "operationId": "getBuildInformationByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The build information id to retrieve.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Build Information",
            "schema": {
              "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Delete a specific Build Information record.",
        "operationId": "deleteBuildInformationBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Build Information to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/build-information": {
      "get": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Retrieve a list of build information records describing the vcs information for a given package",
        "operationId": "getAllBuildInformation",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "A version to look for.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeWorkItems",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "latest",
            "description": "If true, returns only the latest build information.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "packageId",
            "description": "An exact package to look for.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialPackageId",
            "description": "A partial package ID used for a sub-string search.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Build Information",
            "schema": {
              "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Create or update a specific build information record describing the vcs information for a given package",
        "operationId": "createBuildInformation",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateBuildInformationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Build information updated.",
            "schema": {
              "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResource"
            }
          },
          "201": {
            "description": "Build information created.",
            "schema": {
              "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/build-information/bulk": {
      "delete": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Bulk delete specific Build Information records.",
        "operationId": "bulkDeleteBuildInformation",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BulkDeleteBuildInformationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/build-information/{id}": {
      "get": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Retrieve a specific build information record describing the vcs information for a given package",
        "operationId": "getBuildInformationById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The build information id to retrieve.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Build Information",
            "schema": {
              "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "BuildInformation"
        ],
        "summary": "Delete a specific Build Information record.",
        "operationId": "deleteBuildInformation",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Build Information to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/capabilities": {
      "get": {
        "tags": [
          "Capabilities"
        ],
        "summary": "List capabilities (Commands and Requests) this server supports",
        "operationId": "getCapabilities",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested list of Capabilities",
            "schema": {
              "$ref": "#/definitions/GetCapabilitiesResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/capabilities/{capability}": {
      "get": {
        "tags": [
          "Capabilities"
        ],
        "summary": "Query for a single capability (Command or Request)",
        "description": "If the Capability exists, an HTTP 200 (OK) will be returned. If not, a 404 (Not Found) will be returned.",
        "operationId": "requireCapability",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "capability",
            "description": "The capability you want to query for. Name matching is case insensitive. Partial matching is not supported.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Indicates that the Capability exists",
            "schema": {
              "$ref": "#/definitions/RequireCapabilityResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/certificates": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "List X.509 certificates managed by Octopus",
        "operationId": "getCertificates_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "archived",
            "description": "If true, returns only archived Certificates. Otherwise, returns only non-archived Certificates.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "firstResult",
            "description": "Certificate ID which if specified, adds the Certificate with matching ID to the result if it is not already included.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Comma delimited list of Certificate IDs which if specified, filters the result to only include Certificates with matching IDs.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "orderBy",
            "description": "If the value is 'recent' (case-insensitive), then the result will be sorted by Created instead of NotAfter.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Alternative parameter to Search; filters Certificates by Name/Subject/Thumbprint.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "search",
            "description": "Filters Certificates by Name/Subject/Thumbprint.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 15",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "Tenant ID which if specified, filters the result to only include Certificates which are related to the provided Tenant.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Certificates",
            "schema": {
              "$ref": "#/definitions/CertificateResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Create a new certificate.",
        "description": "Adds a new certificate",
        "operationId": "createCertificate_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateCertificateCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/certificates/all": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Get a list of Certificates",
        "description": "Lists X.509 certificates managed by Octopus.",
        "operationId": "getAllCertificates_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "A set of Certificate IDs to retrieve Certificates for. Example: Certificate-101,Certificate-201",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of requested Certificates",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/CertificateResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/certificates/certificate-global": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Get the global Certificate",
        "description": "Returns the server thumbprint used to identify this Octopus Server to any Tentacles when executing a deployment. Deprecated.",
        "operationId": "getGlobalCertificate",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested global Certificate",
            "schema": {
              "$ref": "#/definitions/CertificateConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/certificates/generate": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Create a self-signed Certificate",
        "operationId": "createSelfSignedCertificate_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateSelfSignedCertificateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The newly-created self-signed Certificate.",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/certificates/v2": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "List the X.509 certificates in the supplied Octopus Deploy Space in pages. Current certificates are sorted by soonest expiry first unless OrderBy says otherwise; archived certificates are always sorted by most recently archived.",
        "description": "Skip and Take are required. TotalResults is always the real count of matching certificates, including when Tenant or FirstResult is supplied. Certificate data and passwords are never returned by this endpoint.",
        "operationId": "getCertificatesV2_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "archived",
            "description": "When true, returns only archived certificates. Otherwise, returns only current (non-archived) certificates.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "firstResult",
            "description": "A certificate to return at the top of the first page even if it does not match the other filters, or is archived. Intended for a selector that has to show the currently selected certificate whatever else it lists.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filters the certificates using the specified ids.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "orderBy",
            "description": "The order to return current certificates in: Expiry (the default, soonest to expire first) or Created (most recently added first). Ignored when Archived is true, since archived certificates are always returned most recently archived first. An unrecognised value is treated as Expiry.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "search",
            "description": "Filters the certificates using the specified fragment, matched against each certificate's name, subject and thumbprint.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "Filters the certificates to those the specified Tenant can use, honouring both direct tenant links and tenant tags.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/CertificateResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/certificates/{id}": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Get a Certificate by ID or Thumbprint",
        "operationId": "getCertificateById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID or Thumbprint of the Certificate",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Certificate",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Certificates"
        ],
        "summary": "Modify a certificate by ID",
        "description": "Modifies an existing certificate",
        "operationId": "modifyCertificate_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the certificate",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyCertificateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified certificate resource",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Certificates"
        ],
        "summary": "Delete an existing Certificate",
        "operationId": "deleteCertificate_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/certificates/{id}/archive": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Archive an existing Certificate.",
        "operationId": "archiveCertificate_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to archive",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/certificates/{id}/archive/v1": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Archive an existing Certificate.",
        "operationId": "archiveCertificateV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to archive",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Certificate has been archived",
            "schema": {
              "$ref": "#/definitions/ArchiveCertificateResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/certificates/{id}/export": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Export the certificate",
        "operationId": "exportCertificate_LegacyDefaultSpace",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the certificate to export",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "format",
            "description": "The file format in which to export the certificate",
            "type": "string",
            "enum": [
              "Pkcs12",
              "Der",
              "Pem",
              "Unknown"
            ]
          },
          {
            "in": "query",
            "name": "includePrivateKey",
            "description": "Whether the private key should be included in the exported file",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "password",
            "description": "The password to read the stored certificate",
            "type": "string"
          },
          {
            "in": "query",
            "name": "pemOptions",
            "description": "Whether the exported PEM file should include the certificate chain",
            "type": "string",
            "enum": [
              "PrimaryOnly",
              "PrimaryAndChain",
              "ChainOnly"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/certificates/{id}/replace": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Replace an existing Certificate with another",
        "operationId": "replaceCertificate_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to Replace",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ReplaceCertificateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Certificate has been replaced",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/certificates/{id}/unarchive": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Unarchive an existing archived Certificate.",
        "operationId": "unarchiveCertificate_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to unarchive",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/certificates/{id}/unarchive/v1": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Unarchive an existing archived Certificate.",
        "operationId": "unarchiveCertificateV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to unarchive",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Certificate has been un-archived",
            "schema": {
              "$ref": "#/definitions/UnarchiveCertificateResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/certificates/{id}/usages": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "description": "Get the usages of a certificate",
        "operationId": "getCertificateUsages_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the certificate",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Certificate usages",
            "schema": {
              "$ref": "#/definitions/CertificateUsageResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/configuration/certificates": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Request the list of Certificate Configurations",
        "description": "Only returns configurations for the global Certificate",
        "operationId": "getCertificateConfigurations",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Certificate Configurations",
            "schema": {
              "$ref": "#/definitions/CertificateConfigurationResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/configuration/certificates/{id}": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Get a Certificate Configuration by ID",
        "operationId": "getCertificateConfigurationById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the CertificateConfiguration to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The certificate configuration matching the supplied ID",
            "schema": {
              "$ref": "#/definitions/CertificateConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/configuration/certificates/{id}/public-cer": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Get public certificate",
        "description": "Downloads the public portion of the certificate in .cer format",
        "operationId": "getPublicCertificate",
        "produces": [
          "application/x-x509-ca-cert",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The Id of the certificate to retrieve the public portion of",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/certificates": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "List X.509 certificates managed by Octopus",
        "operationId": "getCertificatesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "archived",
            "description": "If true, returns only archived Certificates. Otherwise, returns only non-archived Certificates.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "firstResult",
            "description": "Certificate ID which if specified, adds the Certificate with matching ID to the result if it is not already included.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Comma delimited list of Certificate IDs which if specified, filters the result to only include Certificates with matching IDs.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "orderBy",
            "description": "If the value is 'recent' (case-insensitive), then the result will be sorted by Created instead of NotAfter.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Alternative parameter to Search; filters Certificates by Name/Subject/Thumbprint.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "search",
            "description": "Filters Certificates by Name/Subject/Thumbprint.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 15",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "Tenant ID which if specified, filters the result to only include Certificates which are related to the provided Tenant.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Certificates",
            "schema": {
              "$ref": "#/definitions/CertificateResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Create a new certificate.",
        "description": "Adds a new certificate",
        "operationId": "createCertificateBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateCertificateCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/certificates/all": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Get a list of Certificates",
        "description": "Lists X.509 certificates managed by Octopus.",
        "operationId": "getAllCertificatesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A set of Certificate IDs to retrieve Certificates for. Example: Certificate-101,Certificate-201",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of requested Certificates",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/CertificateResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/certificates/generate": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Create a self-signed Certificate",
        "operationId": "createSelfSignedCertificateBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateSelfSignedCertificateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The newly-created self-signed Certificate.",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/certificates/v2": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "List the X.509 certificates in the supplied Octopus Deploy Space in pages. Current certificates are sorted by soonest expiry first unless OrderBy says otherwise; archived certificates are always sorted by most recently archived.",
        "description": "Skip and Take are required. TotalResults is always the real count of matching certificates, including when Tenant or FirstResult is supplied. Certificate data and passwords are never returned by this endpoint.",
        "operationId": "getCertificatesV2BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "archived",
            "description": "When true, returns only archived certificates. Otherwise, returns only current (non-archived) certificates.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "firstResult",
            "description": "A certificate to return at the top of the first page even if it does not match the other filters, or is archived. Intended for a selector that has to show the currently selected certificate whatever else it lists.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filters the certificates using the specified ids.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "orderBy",
            "description": "The order to return current certificates in: Expiry (the default, soonest to expire first) or Created (most recently added first). Ignored when Archived is true, since archived certificates are always returned most recently archived first. An unrecognised value is treated as Expiry.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "search",
            "description": "Filters the certificates using the specified fragment, matched against each certificate's name, subject and thumbprint.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "Filters the certificates to those the specified Tenant can use, honouring both direct tenant links and tenant tags.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/CertificateResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/certificates/{id}": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Get a Certificate by ID or Thumbprint",
        "operationId": "getCertificateByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID or Thumbprint of the Certificate",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Certificate",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Certificates"
        ],
        "summary": "Modify a certificate by ID",
        "description": "Modifies an existing certificate",
        "operationId": "modifyCertificateBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the certificate",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyCertificateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified certificate resource",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Certificates"
        ],
        "summary": "Delete an existing Certificate",
        "operationId": "deleteCertificateBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/certificates/{id}/archive": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Archive an existing Certificate.",
        "operationId": "archiveCertificateBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to archive",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/certificates/{id}/archive/v1": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Archive an existing Certificate.",
        "operationId": "archiveCertificateV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to archive",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Certificate has been archived",
            "schema": {
              "$ref": "#/definitions/ArchiveCertificateResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/certificates/{id}/export": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Export the certificate",
        "operationId": "exportCertificateBySpace",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the certificate to export",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "format",
            "description": "The file format in which to export the certificate",
            "type": "string",
            "enum": [
              "Pkcs12",
              "Der",
              "Pem",
              "Unknown"
            ]
          },
          {
            "in": "query",
            "name": "includePrivateKey",
            "description": "Whether the private key should be included in the exported file",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "password",
            "description": "The password to read the stored certificate",
            "type": "string"
          },
          {
            "in": "query",
            "name": "pemOptions",
            "description": "Whether the exported PEM file should include the certificate chain",
            "type": "string",
            "enum": [
              "PrimaryOnly",
              "PrimaryAndChain",
              "ChainOnly"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/certificates/{id}/replace": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Replace an existing Certificate with another",
        "operationId": "replaceCertificateBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to Replace",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ReplaceCertificateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Certificate has been replaced",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/certificates/{id}/unarchive": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Unarchive an existing archived Certificate.",
        "operationId": "unarchiveCertificateBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to unarchive",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/certificates/{id}/unarchive/v1": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Unarchive an existing archived Certificate.",
        "operationId": "unarchiveCertificateV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to unarchive",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Certificate has been un-archived",
            "schema": {
              "$ref": "#/definitions/UnarchiveCertificateResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/certificates/{id}/usages": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "description": "Get the usages of a certificate",
        "operationId": "getCertificateUsagesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the certificate",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Certificate usages",
            "schema": {
              "$ref": "#/definitions/CertificateUsageResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/certificates": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "List X.509 certificates managed by Octopus",
        "operationId": "getCertificates",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "archived",
            "description": "If true, returns only archived Certificates. Otherwise, returns only non-archived Certificates.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "firstResult",
            "description": "Certificate ID which if specified, adds the Certificate with matching ID to the result if it is not already included.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Comma delimited list of Certificate IDs which if specified, filters the result to only include Certificates with matching IDs.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "orderBy",
            "description": "If the value is 'recent' (case-insensitive), then the result will be sorted by Created instead of NotAfter.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Alternative parameter to Search; filters Certificates by Name/Subject/Thumbprint.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "search",
            "description": "Filters Certificates by Name/Subject/Thumbprint.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 15",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "Tenant ID which if specified, filters the result to only include Certificates which are related to the provided Tenant.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Certificates",
            "schema": {
              "$ref": "#/definitions/CertificateResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Create a new certificate.",
        "description": "Adds a new certificate",
        "operationId": "createCertificate",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateCertificateCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/certificates/all": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Get a list of Certificates",
        "description": "Lists X.509 certificates managed by Octopus.",
        "operationId": "getAllCertificates",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A set of Certificate IDs to retrieve Certificates for. Example: Certificate-101,Certificate-201",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of requested Certificates",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/CertificateResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/certificates/generate": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Create a self-signed Certificate",
        "operationId": "createSelfSignedCertificate",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateSelfSignedCertificateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The newly-created self-signed Certificate.",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/certificates/v2": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "List the X.509 certificates in the supplied Octopus Deploy Space in pages. Current certificates are sorted by soonest expiry first unless OrderBy says otherwise; archived certificates are always sorted by most recently archived.",
        "description": "Skip and Take are required. TotalResults is always the real count of matching certificates, including when Tenant or FirstResult is supplied. Certificate data and passwords are never returned by this endpoint.",
        "operationId": "getCertificatesV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "archived",
            "description": "When true, returns only archived certificates. Otherwise, returns only current (non-archived) certificates.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "firstResult",
            "description": "A certificate to return at the top of the first page even if it does not match the other filters, or is archived. Intended for a selector that has to show the currently selected certificate whatever else it lists.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filters the certificates using the specified ids.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "orderBy",
            "description": "The order to return current certificates in: Expiry (the default, soonest to expire first) or Created (most recently added first). Ignored when Archived is true, since archived certificates are always returned most recently archived first. An unrecognised value is treated as Expiry.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "search",
            "description": "Filters the certificates using the specified fragment, matched against each certificate's name, subject and thumbprint.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "Filters the certificates to those the specified Tenant can use, honouring both direct tenant links and tenant tags.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/CertificateResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/certificates/{id}": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Get a Certificate by ID or Thumbprint",
        "operationId": "getCertificateById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID or Thumbprint of the Certificate",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Certificate",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Certificates"
        ],
        "summary": "Modify a certificate by ID",
        "description": "Modifies an existing certificate",
        "operationId": "modifyCertificate",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the certificate",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyCertificateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified certificate resource",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Certificates"
        ],
        "summary": "Delete an existing Certificate",
        "operationId": "deleteCertificate",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/certificates/{id}/archive": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Archive an existing Certificate.",
        "operationId": "archiveCertificate",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to archive",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/certificates/{id}/archive/v1": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Archive an existing Certificate.",
        "operationId": "archiveCertificateV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to archive",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Certificate has been archived",
            "schema": {
              "$ref": "#/definitions/ArchiveCertificateResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/certificates/{id}/export": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Export the certificate",
        "operationId": "exportCertificate",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the certificate to export",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "format",
            "description": "The file format in which to export the certificate",
            "type": "string",
            "enum": [
              "Pkcs12",
              "Der",
              "Pem",
              "Unknown"
            ]
          },
          {
            "in": "query",
            "name": "includePrivateKey",
            "description": "Whether the private key should be included in the exported file",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "password",
            "description": "The password to read the stored certificate",
            "type": "string"
          },
          {
            "in": "query",
            "name": "pemOptions",
            "description": "Whether the exported PEM file should include the certificate chain",
            "type": "string",
            "enum": [
              "PrimaryOnly",
              "PrimaryAndChain",
              "ChainOnly"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/certificates/{id}/replace": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Replace an existing Certificate with another",
        "operationId": "replaceCertificate",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to Replace",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ReplaceCertificateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Certificate has been replaced",
            "schema": {
              "$ref": "#/definitions/CertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/certificates/{id}/unarchive": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Unarchive an existing archived Certificate.",
        "operationId": "unarchiveCertificate",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to unarchive",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/certificates/{id}/unarchive/v1": {
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Unarchive an existing archived Certificate.",
        "operationId": "unarchiveCertificateV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Certificate to unarchive",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Certificate has been un-archived",
            "schema": {
              "$ref": "#/definitions/UnarchiveCertificateResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/certificates/{id}/usages": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "description": "Get the usages of a certificate",
        "operationId": "getCertificateUsages",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the certificate",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Certificate usages",
            "schema": {
              "$ref": "#/definitions/CertificateUsageResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/channels": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a list of Channels",
        "description": "Lists all of the Channels in the supplied Octopus Deploy Space, from all projects, sorted by name.",
        "operationId": "getChannels_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "Comma separated list of Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List of all the Channels in the supplied Octopus Deploy Space, from all projects, sorted by name.",
            "schema": {
              "$ref": "#/definitions/ChannelResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        },
        "deprecated": true
      },
      "post": {
        "tags": [
          "Channels"
        ],
        "summary": "Create a Channel",
        "operationId": "createChannel_LegacyInferProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateChannelCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/channels/all": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a list of Channels",
        "description": "Lists all of the channels in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllChannels_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "A set of Channel IDs to retrieve Channels for. Example: Channel-101,Channel-201",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "List of all of the channels in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ChannelResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/channels/rule-test": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Perform Channel version rule test against provided Package version",
        "operationId": "testChannelVersionRules_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "actions",
            "description": "A list of step names to find a package step which the feed type will determine which version format should be used",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "feedId",
            "description": "A feed ID to determine which version format should be used",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "description": "A feed type to determine which version format should be used",
            "type": "string",
            "enum": [
              "None",
              "NuGet",
              "Docker",
              "Maven",
              "OctopusProject",
              "GitHub",
              "Helm",
              "OciRegistry",
              "AwsElasticContainerRegistry",
              "BuiltIn",
              "S3",
              "AzureContainerRegistry",
              "GoogleContainerRegistry",
              "ArtifactoryGeneric",
              "Npm",
              "GcsStorage",
              "PyPi"
            ]
          },
          {
            "in": "query",
            "name": "preReleaseTag",
            "description": "A regular expression to test the version pre-release tag against",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A deployment process ID in which to search for the steps referenced by the 'Actions' parameter",
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "description": "The version to test",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "description": "A version range to test the version against",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Result of testing Channel version rules",
            "schema": {
              "$ref": "#/definitions/TestChannelVersionRulesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Channels"
        ],
        "summary": "Perform Channel version rule test against provided Package version",
        "operationId": "testChannelVersionRulesUsingPost_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "actions",
            "description": "A list of step names to find a package step which the feed type will determine which version format should be used",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "feedId",
            "description": "A feed ID to determine which version format should be used",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "description": "A feed type to determine which version format should be used",
            "type": "string",
            "enum": [
              "None",
              "NuGet",
              "Docker",
              "Maven",
              "OctopusProject",
              "GitHub",
              "Helm",
              "OciRegistry",
              "AwsElasticContainerRegistry",
              "BuiltIn",
              "S3",
              "AzureContainerRegistry",
              "GoogleContainerRegistry",
              "ArtifactoryGeneric",
              "Npm",
              "GcsStorage",
              "PyPi"
            ]
          },
          {
            "in": "query",
            "name": "preReleaseTag",
            "description": "A regular expression to test the version pre-release tag against",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A deployment process ID in which to search for the steps referenced by the 'Actions' parameter",
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "description": "The version to test",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "description": "A version range to test the version against",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Result of testing Channel version rules",
            "schema": {
              "$ref": "#/definitions/TestChannelVersionRulesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/channels/rule-test/v1": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Test Channel version rules",
        "operationId": "testChannelVersionRulesV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "deploymentProcessId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "type": "string",
            "enum": [
              "None",
              "NuGet",
              "Docker",
              "Maven",
              "OctopusProject",
              "GitHub",
              "Helm",
              "OciRegistry",
              "AwsElasticContainerRegistry",
              "BuiltIn",
              "S3",
              "AzureContainerRegistry",
              "GoogleContainerRegistry",
              "ArtifactoryGeneric",
              "Npm",
              "GcsStorage",
              "PyPi"
            ]
          },
          {
            "in": "query",
            "name": "preReleaseTagPattern",
            "type": "string"
          },
          {
            "in": "query",
            "name": "stepName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionTagRegex",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The result of testing the Channel version rules",
            "schema": {
              "$ref": "#/definitions/TestChannelVersionRulesResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Channels"
        ],
        "summary": "Test Channel version rules",
        "operationId": "testChannelVersionRulesV1UsingPost_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "deploymentProcessId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "type": "string",
            "enum": [
              "None",
              "NuGet",
              "Docker",
              "Maven",
              "OctopusProject",
              "GitHub",
              "Helm",
              "OciRegistry",
              "AwsElasticContainerRegistry",
              "BuiltIn",
              "S3",
              "AzureContainerRegistry",
              "GoogleContainerRegistry",
              "ArtifactoryGeneric",
              "Npm",
              "GcsStorage",
              "PyPi"
            ]
          },
          {
            "in": "query",
            "name": "preReleaseTagPattern",
            "type": "string"
          },
          {
            "in": "query",
            "name": "stepName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionTagRegex",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The result of testing the Channel version rules",
            "schema": {
              "$ref": "#/definitions/TestChannelVersionRulesResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/channels/{id}": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a Channel by ID",
        "operationId": "getChannelById_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Channel to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          }
        },
        "deprecated": true
      },
      "put": {
        "tags": [
          "Channels"
        ],
        "summary": "Update an existing Channel",
        "operationId": "modifyChannel_LegacyInferProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyChannelCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms the Channel was modified, containing the updated Channel",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Channels"
        ],
        "summary": "Delete a ChannelResource by ID",
        "description": "Deletes an existing channel.",
        "operationId": "deleteChannel_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ChannelResource to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/channels": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a list of ChannelResources for the given ProjectResource",
        "description": "Lists all the channels for the given project",
        "operationId": "getChannels_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to limit the set of retrieved Tenants to. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List of all the channels for the given project",
            "schema": {
              "$ref": "#/definitions/ChannelResourceCollection"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Channels"
        ],
        "summary": "Create a Channel",
        "operationId": "createChannel_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateChannelCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The newly-created Channel",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/channels/{id}": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a Channel by ID",
        "operationId": "getChannelById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID or name of a space channel, or the slug of a templated Channel to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The channel matching the supplied Id",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Channels"
        ],
        "summary": "Update an existing Channel",
        "operationId": "modifyChannel_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyChannelCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms the Channel was modified, containing the updated Channel",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Channels"
        ],
        "summary": "Delete a ChannelResource by ID",
        "description": "Deletes an existing channel.",
        "operationId": "deleteChannel_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ChannelResource to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/channels/{id}/v2": {
      "delete": {
        "tags": [
          "Channels"
        ],
        "summary": "Delete a ChannelResource by ID",
        "description": "Deletes an existing channel.",
        "operationId": "deleteChannelV2_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ChannelResource to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Channel has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteChannelResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/channels": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a list of Channels",
        "description": "Lists all of the Channels in the supplied Octopus Deploy Space, from all projects, sorted by name.",
        "operationId": "getChannels_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Comma separated list of Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List of all the Channels in the supplied Octopus Deploy Space, from all projects, sorted by name.",
            "schema": {
              "$ref": "#/definitions/ChannelResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        },
        "deprecated": true
      },
      "post": {
        "tags": [
          "Channels"
        ],
        "summary": "Create a Channel",
        "operationId": "createChannel_LegacyInferProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateChannelCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/channels/all": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a list of Channels",
        "description": "Lists all of the channels in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllChannelsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A set of Channel IDs to retrieve Channels for. Example: Channel-101,Channel-201",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "List of all of the channels in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ChannelResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/channels/rule-test": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Perform Channel version rule test against provided Package version",
        "operationId": "testChannelVersionRulesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "actions",
            "description": "A list of step names to find a package step which the feed type will determine which version format should be used",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "feedId",
            "description": "A feed ID to determine which version format should be used",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "description": "A feed type to determine which version format should be used",
            "type": "string",
            "enum": [
              "None",
              "NuGet",
              "Docker",
              "Maven",
              "OctopusProject",
              "GitHub",
              "Helm",
              "OciRegistry",
              "AwsElasticContainerRegistry",
              "BuiltIn",
              "S3",
              "AzureContainerRegistry",
              "GoogleContainerRegistry",
              "ArtifactoryGeneric",
              "Npm",
              "GcsStorage",
              "PyPi"
            ]
          },
          {
            "in": "query",
            "name": "preReleaseTag",
            "description": "A regular expression to test the version pre-release tag against",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A deployment process ID in which to search for the steps referenced by the 'Actions' parameter",
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "description": "The version to test",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "description": "A version range to test the version against",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Result of testing Channel version rules",
            "schema": {
              "$ref": "#/definitions/TestChannelVersionRulesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Channels"
        ],
        "summary": "Perform Channel version rule test against provided Package version",
        "operationId": "testChannelVersionRulesBySpaceUsingPost",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "actions",
            "description": "A list of step names to find a package step which the feed type will determine which version format should be used",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "feedId",
            "description": "A feed ID to determine which version format should be used",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "description": "A feed type to determine which version format should be used",
            "type": "string",
            "enum": [
              "None",
              "NuGet",
              "Docker",
              "Maven",
              "OctopusProject",
              "GitHub",
              "Helm",
              "OciRegistry",
              "AwsElasticContainerRegistry",
              "BuiltIn",
              "S3",
              "AzureContainerRegistry",
              "GoogleContainerRegistry",
              "ArtifactoryGeneric",
              "Npm",
              "GcsStorage",
              "PyPi"
            ]
          },
          {
            "in": "query",
            "name": "preReleaseTag",
            "description": "A regular expression to test the version pre-release tag against",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A deployment process ID in which to search for the steps referenced by the 'Actions' parameter",
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "description": "The version to test",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "description": "A version range to test the version against",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Result of testing Channel version rules",
            "schema": {
              "$ref": "#/definitions/TestChannelVersionRulesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/channels/rule-test/v1": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Test Channel version rules",
        "operationId": "testChannelVersionRulesV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "deploymentProcessId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "type": "string",
            "enum": [
              "None",
              "NuGet",
              "Docker",
              "Maven",
              "OctopusProject",
              "GitHub",
              "Helm",
              "OciRegistry",
              "AwsElasticContainerRegistry",
              "BuiltIn",
              "S3",
              "AzureContainerRegistry",
              "GoogleContainerRegistry",
              "ArtifactoryGeneric",
              "Npm",
              "GcsStorage",
              "PyPi"
            ]
          },
          {
            "in": "query",
            "name": "preReleaseTagPattern",
            "type": "string"
          },
          {
            "in": "query",
            "name": "stepName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionTagRegex",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The result of testing the Channel version rules",
            "schema": {
              "$ref": "#/definitions/TestChannelVersionRulesResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Channels"
        ],
        "summary": "Test Channel version rules",
        "operationId": "testChannelVersionRulesV1BySpaceUsingPost",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "deploymentProcessId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "type": "string",
            "enum": [
              "None",
              "NuGet",
              "Docker",
              "Maven",
              "OctopusProject",
              "GitHub",
              "Helm",
              "OciRegistry",
              "AwsElasticContainerRegistry",
              "BuiltIn",
              "S3",
              "AzureContainerRegistry",
              "GoogleContainerRegistry",
              "ArtifactoryGeneric",
              "Npm",
              "GcsStorage",
              "PyPi"
            ]
          },
          {
            "in": "query",
            "name": "preReleaseTagPattern",
            "type": "string"
          },
          {
            "in": "query",
            "name": "stepName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionTagRegex",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The result of testing the Channel version rules",
            "schema": {
              "$ref": "#/definitions/TestChannelVersionRulesResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/channels/{id}": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a Channel by ID",
        "operationId": "getChannelById_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Channel to load",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          }
        },
        "deprecated": true
      },
      "put": {
        "tags": [
          "Channels"
        ],
        "summary": "Update an existing Channel",
        "operationId": "modifyChannel_LegacyInferProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyChannelCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms the Channel was modified, containing the updated Channel",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Channels"
        ],
        "summary": "Delete a ChannelResource by ID",
        "description": "Deletes an existing channel.",
        "operationId": "deleteChannel_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ChannelResource to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/channels": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a list of ChannelResources for the given ProjectResource",
        "description": "Lists all the channels for the given project",
        "operationId": "getChannelsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to limit the set of retrieved Tenants to. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List of all the channels for the given project",
            "schema": {
              "$ref": "#/definitions/ChannelResourceCollection"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Channels"
        ],
        "summary": "Create a Channel",
        "operationId": "createChannelBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateChannelCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The newly-created Channel",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/channels/{channelId}/git-reference-rule-validation/v1": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Determine if a git reference satisfies the rules of a channel.",
        "operationId": "gitReferenceSatisfiesChannelGitReferenceRulesV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "channelId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "gitReference",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Represents the result of testing Channel git protection rules.",
            "schema": {
              "$ref": "#/definitions/GitReferenceSatisfiesChannelGitReferenceRulesResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/channels/{channelId}/git-resource-rule-validation/v1": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Determine if a git reference satisfies a channel's Git resource rules.",
        "operationId": "gitReferenceSatisfiesChannelGitResourceRulesV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "channelId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "deploymentActionSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "gitDependencyName",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "gitReference",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Represents the result of testing Channel Git resource rules.",
            "schema": {
              "$ref": "#/definitions/GitReferenceSatisfiesChannelGitResourceRulesResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/channels/{id}": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a Channel by ID",
        "operationId": "getChannelByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID or name of a space channel, or the slug of a templated Channel to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The channel matching the supplied Id",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Channels"
        ],
        "summary": "Update an existing Channel",
        "operationId": "modifyChannelBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyChannelCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms the Channel was modified, containing the updated Channel",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Channels"
        ],
        "summary": "Delete a ChannelResource by ID",
        "description": "Deletes an existing channel.",
        "operationId": "deleteChannelBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ChannelResource to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/channels/{id}/v2": {
      "delete": {
        "tags": [
          "Channels"
        ],
        "summary": "Delete a ChannelResource by ID",
        "description": "Deletes an existing channel.",
        "operationId": "deleteChannelV2BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ChannelResource to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Channel has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteChannelResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/channels": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a list of Channels",
        "description": "Lists all of the Channels in the supplied Octopus Deploy Space, from all projects, sorted by name.",
        "operationId": "getChannels_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Comma separated list of Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List of all the Channels in the supplied Octopus Deploy Space, from all projects, sorted by name.",
            "schema": {
              "$ref": "#/definitions/ChannelResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        },
        "deprecated": true
      },
      "post": {
        "tags": [
          "Channels"
        ],
        "summary": "Create a Channel",
        "operationId": "createChannel_LegacyInferProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateChannelCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/channels/all": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a list of Channels",
        "description": "Lists all of the channels in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllChannels",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A set of Channel IDs to retrieve Channels for. Example: Channel-101,Channel-201",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "List of all of the channels in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ChannelResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/channels/rule-test": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Perform Channel version rule test against provided Package version",
        "operationId": "testChannelVersionRules",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "actions",
            "description": "A list of step names to find a package step which the feed type will determine which version format should be used",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "feedId",
            "description": "A feed ID to determine which version format should be used",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "description": "A feed type to determine which version format should be used",
            "type": "string",
            "enum": [
              "None",
              "NuGet",
              "Docker",
              "Maven",
              "OctopusProject",
              "GitHub",
              "Helm",
              "OciRegistry",
              "AwsElasticContainerRegistry",
              "BuiltIn",
              "S3",
              "AzureContainerRegistry",
              "GoogleContainerRegistry",
              "ArtifactoryGeneric",
              "Npm",
              "GcsStorage",
              "PyPi"
            ]
          },
          {
            "in": "query",
            "name": "preReleaseTag",
            "description": "A regular expression to test the version pre-release tag against",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A deployment process ID in which to search for the steps referenced by the 'Actions' parameter",
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "description": "The version to test",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "description": "A version range to test the version against",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Result of testing Channel version rules",
            "schema": {
              "$ref": "#/definitions/TestChannelVersionRulesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Channels"
        ],
        "summary": "Perform Channel version rule test against provided Package version",
        "operationId": "testChannelVersionRulesUsingPost",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "actions",
            "description": "A list of step names to find a package step which the feed type will determine which version format should be used",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "feedId",
            "description": "A feed ID to determine which version format should be used",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "description": "A feed type to determine which version format should be used",
            "type": "string",
            "enum": [
              "None",
              "NuGet",
              "Docker",
              "Maven",
              "OctopusProject",
              "GitHub",
              "Helm",
              "OciRegistry",
              "AwsElasticContainerRegistry",
              "BuiltIn",
              "S3",
              "AzureContainerRegistry",
              "GoogleContainerRegistry",
              "ArtifactoryGeneric",
              "Npm",
              "GcsStorage",
              "PyPi"
            ]
          },
          {
            "in": "query",
            "name": "preReleaseTag",
            "description": "A regular expression to test the version pre-release tag against",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A deployment process ID in which to search for the steps referenced by the 'Actions' parameter",
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "description": "The version to test",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "description": "A version range to test the version against",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Result of testing Channel version rules",
            "schema": {
              "$ref": "#/definitions/TestChannelVersionRulesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/channels/rule-test/v1": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Test Channel version rules",
        "operationId": "testChannelVersionRulesV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "deploymentProcessId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "type": "string",
            "enum": [
              "None",
              "NuGet",
              "Docker",
              "Maven",
              "OctopusProject",
              "GitHub",
              "Helm",
              "OciRegistry",
              "AwsElasticContainerRegistry",
              "BuiltIn",
              "S3",
              "AzureContainerRegistry",
              "GoogleContainerRegistry",
              "ArtifactoryGeneric",
              "Npm",
              "GcsStorage",
              "PyPi"
            ]
          },
          {
            "in": "query",
            "name": "preReleaseTagPattern",
            "type": "string"
          },
          {
            "in": "query",
            "name": "stepName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionTagRegex",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The result of testing the Channel version rules",
            "schema": {
              "$ref": "#/definitions/TestChannelVersionRulesResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Channels"
        ],
        "summary": "Test Channel version rules",
        "operationId": "testChannelVersionRulesV1UsingPost",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "deploymentProcessId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "type": "string",
            "enum": [
              "None",
              "NuGet",
              "Docker",
              "Maven",
              "OctopusProject",
              "GitHub",
              "Helm",
              "OciRegistry",
              "AwsElasticContainerRegistry",
              "BuiltIn",
              "S3",
              "AzureContainerRegistry",
              "GoogleContainerRegistry",
              "ArtifactoryGeneric",
              "Npm",
              "GcsStorage",
              "PyPi"
            ]
          },
          {
            "in": "query",
            "name": "preReleaseTagPattern",
            "type": "string"
          },
          {
            "in": "query",
            "name": "stepName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionTagRegex",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The result of testing the Channel version rules",
            "schema": {
              "$ref": "#/definitions/TestChannelVersionRulesResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/channels/{id}": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a Channel by ID",
        "operationId": "getChannelById_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Channel to load",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          }
        },
        "deprecated": true
      },
      "put": {
        "tags": [
          "Channels"
        ],
        "summary": "Update an existing Channel",
        "operationId": "modifyChannel_LegacyInferProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyChannelCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms the Channel was modified, containing the updated Channel",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Channels"
        ],
        "summary": "Delete a ChannelResource by ID",
        "description": "Deletes an existing channel.",
        "operationId": "deleteChannel_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ChannelResource to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/channels": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a list of ChannelResources for the given ProjectResource",
        "description": "Lists all the channels for the given project",
        "operationId": "getChannels",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to limit the set of retrieved Tenants to. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List of all the channels for the given project",
            "schema": {
              "$ref": "#/definitions/ChannelResourceCollection"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Channels"
        ],
        "summary": "Create a Channel",
        "operationId": "createChannel",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateChannelCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The newly-created Channel",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/channels/{channelId}/git-reference-rule-validation/v1": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Determine if a git reference satisfies the rules of a channel.",
        "operationId": "gitReferenceSatisfiesChannelGitReferenceRulesV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "channelId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "gitReference",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Represents the result of testing Channel git protection rules.",
            "schema": {
              "$ref": "#/definitions/GitReferenceSatisfiesChannelGitReferenceRulesResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/channels/{channelId}/git-resource-rule-validation/v1": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Determine if a git reference satisfies a channel's Git resource rules.",
        "operationId": "gitReferenceSatisfiesChannelGitResourceRulesV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "channelId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "deploymentActionSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "gitDependencyName",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "gitReference",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Represents the result of testing Channel Git resource rules.",
            "schema": {
              "$ref": "#/definitions/GitReferenceSatisfiesChannelGitResourceRulesResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/channels/{id}": {
      "get": {
        "tags": [
          "Channels"
        ],
        "summary": "Get a Channel by ID",
        "operationId": "getChannelById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID or name of a space channel, or the slug of a templated Channel to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The channel matching the supplied Id",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Channels"
        ],
        "summary": "Update an existing Channel",
        "operationId": "modifyChannel",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyChannelCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms the Channel was modified, containing the updated Channel",
            "schema": {
              "$ref": "#/definitions/ChannelResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Channels"
        ],
        "summary": "Delete a ChannelResource by ID",
        "description": "Deletes an existing channel.",
        "operationId": "deleteChannel",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ChannelResource to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/channels/{id}/v2": {
      "delete": {
        "tags": [
          "Channels"
        ],
        "summary": "Delete a ChannelResource by ID",
        "description": "Deletes an existing channel.",
        "operationId": "deleteChannelV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ChannelResource to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Channel has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteChannelResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/cloudtemplate/{id}/metadata": {
      "post": {
        "tags": [
          "CloudTemplate"
        ],
        "summary": "Request the metadata (ie, parameters and values) for a cloud template (eg, cloudformation, terraform, azure ARM template)",
        "operationId": "getCloudTemplateMetadata",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of a supported cloud template type, eg `CloudFormation`, `Terraform`, `AzureAppService`, `Kubernetes`, etc",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetCloudTemplateMetadataRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The metadata (ie, parameters and values) for a cloud template (eg, cloudformation, terraform, azure ARM template)",
            "schema": {
              "$ref": "#/definitions/CloudTemplateMetadata"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/communityactiontemplates": {
      "get": {
        "tags": [
          "CommunityActionTemplates"
        ],
        "summary": "Get a list of Community Action Templates.",
        "operationId": "getCommunityActionTemplates",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List of Community Action Templates.",
            "schema": {
              "$ref": "#/definitions/CommunityActionTemplateResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/communityactiontemplates/{id}": {
      "get": {
        "tags": [
          "CommunityActionTemplates"
        ],
        "summary": "Get a Community Action Template by ID.",
        "operationId": "getCommunityActionTemplateById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the CommunityActionTemplate to load.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Community Action Template.",
            "schema": {
              "$ref": "#/definitions/CommunityActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/communityactiontemplates/{id}/actiontemplate": {
      "get": {
        "tags": [
          "CommunityActionTemplates"
        ],
        "summary": "Get installed version of the template.",
        "operationId": "getActionTemplateByCommunityActionTemplate_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Community Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "actionTemplateSpaceId",
            "description": "Then ID of the space where the Action Template can be located.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The installed version of the template.",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/communityactiontemplates/{id}/actiontemplate/{actiontemplatespaceId}": {
      "get": {
        "tags": [
          "CommunityActionTemplates"
        ],
        "summary": "Get installed version of the template.",
        "operationId": "getActionTemplateByCommunityActionTemplate",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Community Action Template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "actiontemplatespaceId",
            "description": "Then ID of the space where the Action Template can be located.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The installed version of the template.",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/communityactiontemplates/{id}/installation": {
      "post": {
        "tags": [
          "CommunityActionTemplates"
        ],
        "summary": "Install community step template.",
        "operationId": "installCommunityActionTemplate_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the community action template.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "CommunityActionTemplates"
        ],
        "summary": "Update installed community step template to the latest version.",
        "operationId": "updateCommunityActionTemplateInstallation_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the community action template.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The updated Action Template.",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/communityactiontemplates/{id}/installation/{actiontemplatespaceId}": {
      "post": {
        "tags": [
          "CommunityActionTemplates"
        ],
        "summary": "Install community step template.",
        "operationId": "installCommunityActionTemplate",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the community action template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "actiontemplatespaceId",
            "description": "The ID of the Space where the action template should be installed.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "CommunityActionTemplates"
        ],
        "summary": "Update installed community step template to the latest version.",
        "operationId": "updateCommunityActionTemplateInstallation",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the community action template.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "actiontemplatespaceId",
            "description": "The ID of the Space where the action template should be installed.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The updated Action Template.",
            "schema": {
              "$ref": "#/definitions/ActionTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/communityactiontemplates/{id}/logo": {
      "get": {
        "tags": [
          "CommunityActionTemplates"
        ],
        "summary": "Get the logo associated with the community step template.",
        "operationId": "getCommunityActionTemplateLogo",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the community action template.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/policies/{slug}/versions": {
      "get": {
        "tags": [
          "CompliancePolicies"
        ],
        "summary": "Request the published versions for a policy",
        "operationId": "getCompliancePolicyVersions",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested policy version",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/CompliancePolicyVersionResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/policies/{slug}/versions/v2": {
      "get": {
        "tags": [
          "CompliancePolicies"
        ],
        "summary": "Request the published versions for a policy",
        "operationId": "getCompliancePolicyVersionsV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/CompliancePolicyVersionResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/policies/{slug}/versions/{version}/modify-status": {
      "post": {
        "tags": [
          "CompliancePolicies"
        ],
        "summary": "Modify the activation status for a policy version",
        "operationId": "modifyCompliancePolicyVersionActivationStatus",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "version",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyCompliancePolicyVersionActivationStatusCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested policy version",
            "schema": {
              "$ref": "#/definitions/CompliancePolicyVersionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/{gitRef}/policies": {
      "get": {
        "tags": [
          "CompliancePolicies"
        ],
        "summary": "Request a paginated set of CompliancePolicyResource sorted by name",
        "operationId": "getAllCompliancePoliciesByGitRef",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated set of CompliancePolicyResource sorted by name",
            "schema": {
              "$ref": "#/definitions/GetAllCompliancePoliciesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "CompliancePolicies"
        ],
        "summary": "Create a new policy",
        "operationId": "createCompliancePolicyByGitRef",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateCompliancePolicyCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CompliancePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/{gitRef}/policies/{slug}": {
      "get": {
        "tags": [
          "CompliancePolicies"
        ],
        "summary": "Request a single CompliancePolicyResource by slug and git reference",
        "operationId": "getCompliancePolicyBySlugByGitRef",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Represents a Compliance Policy",
            "schema": {
              "$ref": "#/definitions/CompliancePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "CompliancePolicies"
        ],
        "summary": "Modify an existing policy",
        "operationId": "modifyCompliancePolicyByGitRef",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyCompliancePolicyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Represents a Compliance Policy",
            "schema": {
              "$ref": "#/definitions/CompliancePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/{gitRef}/policies/{slug}/publish": {
      "post": {
        "tags": [
          "CompliancePolicies"
        ],
        "summary": "Create new version of policy",
        "operationId": "publishCompliancePolicyByGitRef",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/PublishCompliancePolicyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested policy version",
            "schema": {
              "$ref": "#/definitions/CompliancePolicyVersionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/configuration": {
      "get": {
        "tags": [
          "Configuration"
        ],
        "summary": "Return a list of configuration section settings",
        "operationId": "getConfigurationSectionList",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The list of configuration section settings",
            "schema": {
              "$ref": "#/definitions/ConfigurationSectionCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/configuration/{id}": {
      "get": {
        "tags": [
          "Configuration"
        ],
        "summary": "Return a single configuration section for the given id",
        "operationId": "getConfigurationSection",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested configuration section",
            "schema": {
              "$ref": "#/definitions/ConfigurationSection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/configuration/{id}/metadata": {
      "get": {
        "tags": [
          "Configuration"
        ],
        "summary": "Return a structure that describes how to dynamically render the configuration section",
        "operationId": "getConfigurationSectionMetadata",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested configuration section metadata",
            "schema": {
              "$ref": "#/definitions/Metadata"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/configuration/{id}/values": {
      "get": {
        "tags": [
          "Configuration"
        ],
        "summary": "Return the current configuration for a specific configuration section",
        "operationId": "getConfigurationSectionValues",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The current configuration for the specified configuration section",
            "schema": { }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Configuration"
        ],
        "summary": "Update the configuration values for a specific configuration section.",
        "description": "Refer to the configuration/{id}/metadata endpoint for details on the specific data structure required for a given configuration section id.",
        "operationId": "updateConfigurationSectionValues",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": { }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": { }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        }
      }
    },
    "/connectionagent": {
      "get": {
        "tags": [
          "ConnectionAgents"
        ],
        "summary": "List all registered Connection Agents",
        "operationId": "listConnectionAgentRegistrations",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ConnectionAgentResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ConnectionAgents"
        ],
        "summary": "Register a Connection Agent",
        "operationId": "createConnectionAgentRegistration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateConnectionAgentRegistrationCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ConnectionAgentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/connectionagent/forwardingrules": {
      "get": {
        "tags": [
          "ConnectionAgents"
        ],
        "summary": "List all Connection Agent forwarding rules.",
        "operationId": "listConnectionAgentForwardingRules",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ConnectionAgentForwardingRuleResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ConnectionAgents"
        ],
        "summary": "Create or update a Connection Agent forwarding rule, mapping an FQDN to a Connection Agent.",
        "operationId": "setConnectionAgentForwardingRule",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/SetConnectionAgentForwardingRuleCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A Connection Agent forwarding rule, mapping an FQDN to a Connection Agent.",
            "schema": {
              "$ref": "#/definitions/ConnectionAgentForwardingRuleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ConnectionAgents"
        ],
        "summary": "Delete a Connection Agent forwarding rule.",
        "operationId": "deleteConnectionAgentForwardingRule",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/DeleteConnectionAgentForwardingRuleCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Response from deleting a Connection Agent forwarding rule.",
            "schema": {
              "$ref": "#/definitions/DeleteConnectionAgentForwardingRuleResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/connectionagent/{connectionAgentName}": {
      "get": {
        "tags": [
          "ConnectionAgents"
        ],
        "summary": "Get a single registered Connection Agent by name",
        "operationId": "getConnectionAgentRegistration",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "connectionAgentName",
            "description": "The Connection Agent Name",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A connection agent registration record",
            "schema": {
              "$ref": "#/definitions/ConnectionAgentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ConnectionAgents"
        ],
        "summary": "Unregister a Connection Agent",
        "operationId": "deleteConnectionAgentRegistration",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "connectionAgentName",
            "description": "The Connection Agent name",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response from deleting a Connection Agent registration",
            "schema": {
              "$ref": "#/definitions/DeleteConnectionAgentRegistrationResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/connectionagent/{connectionAgentName}/credentials": {
      "post": {
        "tags": [
          "ConnectionAgents"
        ],
        "summary": "Add a credential to an existing Connection Agent",
        "operationId": "addConnectionAgentCredential",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "connectionAgentName",
            "description": "The Connection Agent Name",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/AddConnectionAgentCredentialCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A connection agent registration record",
            "schema": {
              "$ref": "#/definitions/ConnectionAgentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/connectionagent/{connectionAgentName}/credentials/{credentialName}": {
      "delete": {
        "tags": [
          "ConnectionAgents"
        ],
        "summary": "Remove a credential from a Connection Agent",
        "operationId": "removeConnectionAgentCredential",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "connectionAgentName",
            "description": "The Connection Agent name",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "credentialName",
            "description": "The name of the credential to remove",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A connection agent registration record",
            "schema": {
              "$ref": "#/definitions/ConnectionAgentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/dashboard": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "summary": "Return information required to render the Octopus dashboard",
        "operationId": "getDashboard_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "highestLatestVersionPerProjectAndEnvironment",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "selectedTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "selectedTenants",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "showAll",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Dashboard",
            "schema": {
              "$ref": "#/definitions/DashboardResource"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/dashboard/dynamic": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "summary": "Return the information required to render the dynamic dashboard. Deprecated.",
        "operationId": "getDynamicDashboard_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "environments",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "includePrevious",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projects",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Dynamic Dashboared",
            "schema": {
              "$ref": "#/definitions/DashboardResource"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/dashboard": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "summary": "Return information required to render the Octopus dashboard",
        "operationId": "getDashboardBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "highestLatestVersionPerProjectAndEnvironment",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "selectedTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "selectedTenants",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "showAll",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Dashboard",
            "schema": {
              "$ref": "#/definitions/DashboardResource"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/dashboard/dynamic": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "summary": "Return the information required to render the dynamic dashboard. Deprecated.",
        "operationId": "getDynamicDashboardBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environments",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "includePrevious",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projects",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Dynamic Dashboared",
            "schema": {
              "$ref": "#/definitions/DashboardResource"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/dashboard": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "summary": "Return information required to render the Octopus dashboard",
        "operationId": "getDashboard",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "highestLatestVersionPerProjectAndEnvironment",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "selectedTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "selectedTenants",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "showAll",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Dashboard",
            "schema": {
              "$ref": "#/definitions/DashboardResource"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/dashboard/dynamic": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "summary": "Return the information required to render the dynamic dashboard. Deprecated.",
        "operationId": "getDynamicDashboard",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environments",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "includePrevious",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projects",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Dynamic Dashboared",
            "schema": {
              "$ref": "#/definitions/DashboardResource"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/dashboardconfiguration": {
      "get": {
        "tags": [
          "DashboardConfiguration"
        ],
        "summary": "Get dashboard configuration",
        "description": "Gets the dashboard configuration of the authenticated user for the current space",
        "operationId": "getDashboardConfiguration_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested Dashboard Configuration",
            "schema": {
              "$ref": "#/definitions/DashboardConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DashboardConfiguration"
        ],
        "summary": "Modify dashboard configuration",
        "description": "Modifies the dashboard configuration for the current user per space",
        "operationId": "modifyDashboardConfiguration_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDashboardConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Dashboard Configuration was modified, containing the new configuration",
            "schema": {
              "$ref": "#/definitions/DashboardConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/dashboardconfiguration": {
      "get": {
        "tags": [
          "DashboardConfiguration"
        ],
        "summary": "Get dashboard configuration",
        "description": "Gets the dashboard configuration of the authenticated user for the current space",
        "operationId": "getDashboardConfigurationBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s)",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Dashboard Configuration",
            "schema": {
              "$ref": "#/definitions/DashboardConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DashboardConfiguration"
        ],
        "summary": "Modify dashboard configuration",
        "description": "Modifies the dashboard configuration for the current user per space",
        "operationId": "modifyDashboardConfigurationBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the DashboardConfiguration.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDashboardConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Dashboard Configuration was modified, containing the new configuration",
            "schema": {
              "$ref": "#/definitions/DashboardConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/dashboardconfiguration": {
      "get": {
        "tags": [
          "DashboardConfiguration"
        ],
        "summary": "Get dashboard configuration",
        "description": "Gets the dashboard configuration of the authenticated user for the current space",
        "operationId": "getDashboardConfiguration",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Dashboard Configuration",
            "schema": {
              "$ref": "#/definitions/DashboardConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DashboardConfiguration"
        ],
        "summary": "Modify dashboard configuration",
        "description": "Modifies the dashboard configuration for the current user per space",
        "operationId": "modifyDashboardConfiguration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDashboardConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Dashboard Configuration was modified, containing the new configuration",
            "schema": {
              "$ref": "#/definitions/DashboardConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deploymentfreezes": {
      "get": {
        "tags": [
          "DeploymentFreeze"
        ],
        "summary": "Get DeploymentFreezes",
        "description": "Gets a paginated set of DeploymentFreezes.",
        "operationId": "getDeploymentFreezes",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "effectiveDate",
            "description": "URL encoded timestamp to search recurring deployment freezes at a given point in time",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "environmentIds",
            "description": "List of Environment IDs which if specified, filters the result to only include DeploymentFreeze with matching Environment IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of DeploymentFreeze IDs which if specified, filters the result to only include DeploymentFreeze with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "includeComplete",
            "description": "Set to false to only return active Deployment Freezes",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectIds",
            "description": "List of Project IDs which if specified, filters the result to only include DeploymentFreeze with matching Project IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "status",
            "type": "string"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tenantIds",
            "description": "List of Tenant IDs which if specified, filters the result to only include DeploymentFreeze with matching Tenant IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of DeploymentFreezes",
            "schema": {
              "$ref": "#/definitions/GetDeploymentFreezesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "DeploymentFreeze"
        ],
        "summary": "Create a new deployment freeze.",
        "operationId": "createDeploymentFreeze",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentFreezeCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentFreezeResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deploymentfreezes/{id}": {
      "get": {
        "tags": [
          "DeploymentFreeze"
        ],
        "summary": "Get a deployment freeze by ID",
        "operationId": "getDeploymentFreezeById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the deployment freeze",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested deployment freeze",
            "schema": {
              "$ref": "#/definitions/GetDeploymentFreezeByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentFreeze"
        ],
        "summary": "Create a new deployment freeze.",
        "operationId": "modifyDeploymentFreeze",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentFreezeCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Modifies an existing deployment freeze",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentFreezeResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "DeploymentFreeze"
        ],
        "summary": "Delete a deployment freeze.",
        "operationId": "deleteDeploymentFreeze",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the DeploymentFreeze to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deployments/override": {
      "post": {
        "tags": [
          "DeploymentFreeze"
        ],
        "summary": "Override a deployment freeze to create a deployment.",
        "operationId": "createDeploymentFreezeOverride_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentFreezeOverrideCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentFreezeOverrideResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/deployments/override": {
      "post": {
        "tags": [
          "DeploymentFreeze"
        ],
        "summary": "Override a deployment freeze to create a deployment.",
        "operationId": "createDeploymentFreezeOverrideBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentFreezeOverrideCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentFreezeOverrideResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/deployments/override": {
      "post": {
        "tags": [
          "DeploymentFreeze"
        ],
        "summary": "Override a deployment freeze to create a deployment.",
        "operationId": "createDeploymentFreezeOverride",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentFreezeOverrideCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentFreezeOverrideResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deploymentprocesses": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "List all the deployment processes",
        "description": "Lists all the deployment processes in the supplied Octopus Deploy Space, sorted by Id.",
        "operationId": "getAllDeploymentProcesses_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "A list of DeploymentProcess IDs, to limit the matching of DeploymentProcesses to those with a particular ID. Example: [\"deploymentprocess-Projects-1\", \"deploymentprocess-Projects-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Deployment Processes",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deploymentprocesses/{deploymentProcessId}/template": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get a Release Snapshot Template.",
        "operationId": "getReleaseSnapshotTemplate_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "deploymentProcessId",
            "description": "The ID of the Deployment Process to use.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channel",
            "description": "The channel ID to get the channel from.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseId",
            "description": "The ID of the release to get variables from.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Template.",
            "schema": {
              "$ref": "#/definitions/ReleaseTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deploymentprocesses/{id}": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get a specific snapshotted version of a deployment process",
        "operationId": "getDeploymentProcessSnapshot_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the snapshotted deployment process, for example \"deploymentprocess-Projects-1-s-4-ABCDE\".",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Get a specific snapshotted version of a deployment process",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Modify a deployment process",
        "description": "Modifies a deployment process. Only allowed for deployment processes owned by a project (cannot be used to change the deployment process owned by a release).",
        "operationId": "updateDeploymentProcessById_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the deployment process to update. Example `deploymentprocess-Projects-1`",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          }
        },
        "deprecated": true
      }
    },
    "/projects/{projectId}/deploymentprocesses": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get the deployment process for a project",
        "operationId": "getDeploymentProcessInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the deployment process for a project",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Modify a deployment process",
        "description": "Modifies a deployment process. Only allowed for deployment processes owned by a project (cannot be used to change the deployment process owned by a release).",
        "operationId": "modifyDeploymentProcessInDatabase_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentProcessInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Process has been modified, containing the new Process",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/deploymentprocesses/template": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get all of the information necessary for creating or editing a release using this deployment process.",
        "operationId": "getReleaseTemplateInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the Project to use.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channel",
            "description": "The channel ID to get the channel from.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseId",
            "description": "The ID of the release to get variables from.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Template",
            "schema": {
              "$ref": "#/definitions/ReleaseTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/deploymentprocesses/validate": {
      "post": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Validate the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.",
        "operationId": "validateDeploymentProcessInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the result of validation, such as warnings for the deployment process",
            "schema": {
              "$ref": "#/definitions/ValidateDeploymentProcessInDatabaseResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/deploymentprocesses": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get the deployment process for a version-controlled project",
        "operationId": "getDeploymentProcessInGit_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the deployment process for a project",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Modify a deployment process",
        "description": "Modifies a deployment process. Only allowed for deployment processes owned by a project (cannot be used to change the deployment process owned by a release).",
        "operationId": "modifyDeploymentProcessInGit_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentProcessInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Process has been modified, containing the new Process",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/deploymentprocesses/template": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get all of the information necessary for creating or editing a release using this deployment process.",
        "operationId": "getReleaseTemplateInGit_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the Project to use.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "GitRef for the project variables",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channel",
            "description": "The channel ID to get the channel from.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseId",
            "description": "The ID of the release to get variables from.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Template",
            "schema": {
              "$ref": "#/definitions/ReleaseTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/deploymentprocesses/validate": {
      "post": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Validate the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.",
        "operationId": "validateDeploymentProcessInGit_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the result of validation, such as warnings for the deployment process",
            "schema": {
              "$ref": "#/definitions/ValidateDeploymentProcessInGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/deploymentprocesses": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "List all the deployment processes",
        "description": "Lists all the deployment processes in the supplied Octopus Deploy Space, sorted by Id.",
        "operationId": "getAllDeploymentProcessesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of DeploymentProcess IDs, to limit the matching of DeploymentProcesses to those with a particular ID. Example: [\"deploymentprocess-Projects-1\", \"deploymentprocess-Projects-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Deployment Processes",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/deploymentprocesses/{deploymentProcessId}/template": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get a Release Snapshot Template.",
        "operationId": "getReleaseSnapshotTemplateBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "deploymentProcessId",
            "description": "The ID of the Deployment Process to use.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channel",
            "description": "The channel ID to get the channel from.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseId",
            "description": "The ID of the release to get variables from.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Template.",
            "schema": {
              "$ref": "#/definitions/ReleaseTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/deploymentprocesses/{id}": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get a specific snapshotted version of a deployment process",
        "operationId": "getDeploymentProcessSnapshotBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the snapshotted deployment process, for example \"deploymentprocess-Projects-1-s-4-ABCDE\".",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Get a specific snapshotted version of a deployment process",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Modify a deployment process",
        "description": "Modifies a deployment process. Only allowed for deployment processes owned by a project (cannot be used to change the deployment process owned by a release).",
        "operationId": "updateDeploymentProcessByIdBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the deployment process to update. Example `deploymentprocess-Projects-1`",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          }
        },
        "deprecated": true
      }
    },
    "/{spaceId}/projects/{projectId}/deploymentprocesses": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get the deployment process for a project",
        "operationId": "getDeploymentProcessInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the deployment process for a project",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Modify a deployment process",
        "description": "Modifies a deployment process. Only allowed for deployment processes owned by a project (cannot be used to change the deployment process owned by a release).",
        "operationId": "modifyDeploymentProcessInDatabaseBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentProcessInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Process has been modified, containing the new Process",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/deploymentprocesses/resolved": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get the resolved deployment process for a project.",
        "description": "This request returns the deployment process with all process template usages resolved out to the deployment steps that are executed. If a process template usage cannot be resolved (e.g. if the process template is no longer shared with the space), the usage will be excluded from the response.",
        "operationId": "getResolvedDeploymentProcessInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The deployment process for a project",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/deploymentprocesses/template": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get all of the information necessary for creating or editing a release using this deployment process.",
        "operationId": "getReleaseTemplateInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the Project to use.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channel",
            "description": "The channel ID to get the channel from.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseId",
            "description": "The ID of the release to get variables from.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Template",
            "schema": {
              "$ref": "#/definitions/ReleaseTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/deploymentprocesses/validate": {
      "post": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Validate the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.",
        "operationId": "validateDeploymentProcessInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the result of validation, such as warnings for the deployment process",
            "schema": {
              "$ref": "#/definitions/ValidateDeploymentProcessInDatabaseResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/deploymentprocesses": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get the deployment process for a version-controlled project",
        "operationId": "getDeploymentProcessInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the deployment process for a project",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Modify a deployment process",
        "description": "Modifies a deployment process. Only allowed for deployment processes owned by a project (cannot be used to change the deployment process owned by a release).",
        "operationId": "modifyDeploymentProcessInGitBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentProcessInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Process has been modified, containing the new Process",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/deploymentprocesses/resolved": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get the resolved deployment process for a version-controlled project",
        "description": "This request returns the deployment process with all process template usages resolved out to the deployment steps that are executed. If a process template usage cannot be resolved (e.g. if the process template is no longer shared with the space), the usage will be excluded from the response.",
        "operationId": "getResolvedDeploymentProcessInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The deployment process for a project",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/deploymentprocesses/template": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get all of the information necessary for creating or editing a release using this deployment process.",
        "operationId": "getReleaseTemplateInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the Project to use.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "GitRef for the project variables",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channel",
            "description": "The channel ID to get the channel from.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseId",
            "description": "The ID of the release to get variables from.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Template",
            "schema": {
              "$ref": "#/definitions/ReleaseTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/deploymentprocesses/validate": {
      "post": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Validate the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.",
        "operationId": "validateDeploymentProcessInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the result of validation, such as warnings for the deployment process",
            "schema": {
              "$ref": "#/definitions/ValidateDeploymentProcessInGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/deploymentprocesses": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "List all the deployment processes",
        "description": "Lists all the deployment processes in the supplied Octopus Deploy Space, sorted by Id.",
        "operationId": "getAllDeploymentProcesses",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of DeploymentProcess IDs, to limit the matching of DeploymentProcesses to those with a particular ID. Example: [\"deploymentprocess-Projects-1\", \"deploymentprocess-Projects-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Deployment Processes",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/deploymentprocesses/{deploymentProcessId}/template": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get a Release Snapshot Template.",
        "operationId": "getReleaseSnapshotTemplate",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "deploymentProcessId",
            "description": "The ID of the Deployment Process to use.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channel",
            "description": "The channel ID to get the channel from.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseId",
            "description": "The ID of the release to get variables from.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Template.",
            "schema": {
              "$ref": "#/definitions/ReleaseTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/deploymentprocesses/{id}": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get a specific snapshotted version of a deployment process",
        "operationId": "getDeploymentProcessSnapshot",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the snapshotted deployment process, for example \"deploymentprocess-Projects-1-s-4-ABCDE\".",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Get a specific snapshotted version of a deployment process",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Modify a deployment process",
        "description": "Modifies a deployment process. Only allowed for deployment processes owned by a project (cannot be used to change the deployment process owned by a release).",
        "operationId": "updateDeploymentProcessById",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the deployment process to update. Example `deploymentprocess-Projects-1`",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          }
        },
        "deprecated": true
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/deploymentprocesses": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get the deployment process for a project",
        "operationId": "getDeploymentProcessInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the deployment process for a project",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Modify a deployment process",
        "description": "Modifies a deployment process. Only allowed for deployment processes owned by a project (cannot be used to change the deployment process owned by a release).",
        "operationId": "modifyDeploymentProcessInDatabase",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentProcessInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Process has been modified, containing the new Process",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/deploymentprocesses/resolved": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get the resolved deployment process for a project.",
        "description": "This request returns the deployment process with all process template usages resolved out to the deployment steps that are executed. If a process template usage cannot be resolved (e.g. if the process template is no longer shared with the space), the usage will be excluded from the response.",
        "operationId": "getResolvedDeploymentProcessInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The deployment process for a project",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/deploymentprocesses/template": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get all of the information necessary for creating or editing a release using this deployment process.",
        "operationId": "getReleaseTemplateInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the Project to use.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channel",
            "description": "The channel ID to get the channel from.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseId",
            "description": "The ID of the release to get variables from.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Template",
            "schema": {
              "$ref": "#/definitions/ReleaseTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/deploymentprocesses/validate": {
      "post": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Validate the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.",
        "operationId": "validateDeploymentProcessInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the result of validation, such as warnings for the deployment process",
            "schema": {
              "$ref": "#/definitions/ValidateDeploymentProcessInDatabaseResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/deploymentprocesses": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get the deployment process for a version-controlled project",
        "operationId": "getDeploymentProcessInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the deployment process for a project",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Modify a deployment process",
        "description": "Modifies a deployment process. Only allowed for deployment processes owned by a project (cannot be used to change the deployment process owned by a release).",
        "operationId": "modifyDeploymentProcessInGit",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentProcessInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Process has been modified, containing the new Process",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/deploymentprocesses/resolved": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get the resolved deployment process for a version-controlled project",
        "description": "This request returns the deployment process with all process template usages resolved out to the deployment steps that are executed. If a process template usage cannot be resolved (e.g. if the process template is no longer shared with the space), the usage will be excluded from the response.",
        "operationId": "getResolvedDeploymentProcessInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The deployment process for a project",
            "schema": {
              "$ref": "#/definitions/DeploymentProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/deploymentprocesses/template": {
      "get": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Get all of the information necessary for creating or editing a release using this deployment process.",
        "operationId": "getReleaseTemplateInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the Project to use.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "GitRef for the project variables",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channel",
            "description": "The channel ID to get the channel from.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseId",
            "description": "The ID of the release to get variables from.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Template",
            "schema": {
              "$ref": "#/definitions/ReleaseTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/deploymentprocesses/validate": {
      "post": {
        "tags": [
          "DeploymentProcesses"
        ],
        "summary": "Validate the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.",
        "operationId": "validateDeploymentProcessInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the result of validation, such as warnings for the deployment process",
            "schema": {
              "$ref": "#/definitions/ValidateDeploymentProcessInGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deployments": {
      "get": {
        "tags": [
          "Deployments"
        ],
        "summary": "Get a list of Deployments",
        "description": "Lists all of the Deployments in the supplied Space. The results will be sorted from most recent to least recent deployment.",
        "operationId": "getDeployments_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "channels",
            "description": "Channel Ids to filter results to only Deployments with the given Channel Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environments",
            "description": "Environment Ids to filter results to only Deployments with the given Environment Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Deployment Ids to filter results to only Deployments with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Deployments to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projects",
            "description": "Project Ids to filter results to only Deployments with the given Project Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "taskState",
            "description": "Task State to filter results to only Deployments with the given Task State",
            "type": "string",
            "enum": [
              "Queued",
              "Executing",
              "Failed",
              "Canceled",
              "TimedOut",
              "Success",
              "Cancelling"
            ]
          },
          {
            "in": "query",
            "name": "tenants",
            "description": "Tenant Ids to filter results to only Deployments with the given Tenant Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployments",
            "schema": {
              "$ref": "#/definitions/DeploymentResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Deployments"
        ],
        "summary": "Create a Deployment",
        "operationId": "createDeployment_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/DeploymentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deployments/v1": {
      "post": {
        "tags": [
          "Deployments"
        ],
        "summary": "Create a Deployment",
        "operationId": "createDeploymentV1_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deployments/{id}": {
      "get": {
        "tags": [
          "Deployments"
        ],
        "summary": "Get a Deployment by ID.",
        "operationId": "getDeploymentById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment to load.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment.",
            "schema": {
              "$ref": "#/definitions/DeploymentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Deployments"
        ],
        "summary": "Delete an existing Deployment.",
        "operationId": "deleteDeployment_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/deployments": {
      "get": {
        "tags": [
          "Deployments"
        ],
        "summary": "Get a list of Deployments",
        "description": "Lists all of the Deployments in the supplied Space. The results will be sorted from most recent to least recent deployment.",
        "operationId": "getDeploymentsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space to which the Deployments belong.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channels",
            "description": "Channel Ids to filter results to only Deployments with the given Channel Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environments",
            "description": "Environment Ids to filter results to only Deployments with the given Environment Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Deployment Ids to filter results to only Deployments with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Deployments to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projects",
            "description": "Project Ids to filter results to only Deployments with the given Project Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "taskState",
            "description": "Task State to filter results to only Deployments with the given Task State",
            "type": "string",
            "enum": [
              "Queued",
              "Executing",
              "Failed",
              "Canceled",
              "TimedOut",
              "Success",
              "Cancelling"
            ]
          },
          {
            "in": "query",
            "name": "tenants",
            "description": "Tenant Ids to filter results to only Deployments with the given Tenant Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployments",
            "schema": {
              "$ref": "#/definitions/DeploymentResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Deployments"
        ],
        "summary": "Create a Deployment",
        "operationId": "createDeploymentBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/DeploymentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/deployments/create/tenanted/v1": {
      "post": {
        "tags": [
          "Deployments"
        ],
        "summary": "Create a new tenanted deployment.",
        "operationId": "createDeploymentTenantedV1BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentTenantedCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Server tasks associated with the newly-created Deployment",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentTenantedResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/deployments/create/untenanted/v1": {
      "post": {
        "tags": [
          "Deployments"
        ],
        "summary": "Create a new untenanted deployment",
        "operationId": "createDeploymentUntenantedV1BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentUntenantedCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Server tasks associated with the newly-created Deployment",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentUntenantedResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/deployments/v1": {
      "post": {
        "tags": [
          "Deployments"
        ],
        "summary": "Create a Deployment",
        "operationId": "createDeploymentV1BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/deployments/{id}": {
      "get": {
        "tags": [
          "Deployments"
        ],
        "summary": "Get a Deployment by ID.",
        "operationId": "getDeploymentByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment to load.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment.",
            "schema": {
              "$ref": "#/definitions/DeploymentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Deployments"
        ],
        "summary": "Delete an existing Deployment.",
        "operationId": "deleteDeploymentBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/deployments": {
      "get": {
        "tags": [
          "Deployments"
        ],
        "summary": "Get a list of Deployments",
        "description": "Lists all of the Deployments in the supplied Space. The results will be sorted from most recent to least recent deployment.",
        "operationId": "getDeployments",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channels",
            "description": "Channel Ids to filter results to only Deployments with the given Channel Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environments",
            "description": "Environment Ids to filter results to only Deployments with the given Environment Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Deployment Ids to filter results to only Deployments with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Deployments to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projects",
            "description": "Project Ids to filter results to only Deployments with the given Project Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "taskState",
            "description": "Task State to filter results to only Deployments with the given Task State",
            "type": "string",
            "enum": [
              "Queued",
              "Executing",
              "Failed",
              "Canceled",
              "TimedOut",
              "Success",
              "Cancelling"
            ]
          },
          {
            "in": "query",
            "name": "tenants",
            "description": "Tenant Ids to filter results to only Deployments with the given Tenant Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployments",
            "schema": {
              "$ref": "#/definitions/DeploymentResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Deployments"
        ],
        "summary": "Create a Deployment",
        "operationId": "createDeployment",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/DeploymentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/deployments/create/tenanted/v1": {
      "post": {
        "tags": [
          "Deployments"
        ],
        "summary": "Create a new tenanted deployment.",
        "operationId": "createDeploymentTenantedV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentTenantedCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Server tasks associated with the newly-created Deployment",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentTenantedResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/deployments/create/untenanted/v1": {
      "post": {
        "tags": [
          "Deployments"
        ],
        "summary": "Create a new untenanted deployment",
        "operationId": "createDeploymentUntenantedV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentUntenantedCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Server tasks associated with the newly-created Deployment",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentUntenantedResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/deployments/v1": {
      "post": {
        "tags": [
          "Deployments"
        ],
        "summary": "Create a Deployment",
        "operationId": "createDeploymentV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/deployments/{id}": {
      "get": {
        "tags": [
          "Deployments"
        ],
        "summary": "Get a Deployment by ID.",
        "operationId": "getDeploymentById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment to load.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment.",
            "schema": {
              "$ref": "#/definitions/DeploymentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Deployments"
        ],
        "summary": "Delete an existing Deployment.",
        "operationId": "deleteDeployment",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deploymentsettings/{id}": {
      "get": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Get deployment settings by ID.",
        "operationId": "getDeploymentSettingsById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the DeploymentSettings to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          }
        },
        "deprecated": true
      }
    },
    "/deploymentsettings/{projectId}": {
      "put": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Modify deployment settings",
        "description": "Modifies deployment settings for a project.",
        "operationId": "modifyDeploymentSettingsInDatabase_LegacyDefaultSpace_Legacy0",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentSettingsInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Settings were modified, contains the updated Deployment Settings",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        },
        "deprecated": true
      }
    },
    "/projects/{projectId}/deploymentsettings": {
      "get": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Get deployment settings by ID.",
        "operationId": "getDeploymentSettingsInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment Settings.",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Modify deployment settings",
        "description": "Modifies deployment settings for a project.",
        "operationId": "modifyDeploymentSettingsInDatabase_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentSettingsInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Settings were modified, contains the updated Deployment Settings",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/deploymentsettings": {
      "get": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Get deployment settings by ID.",
        "operationId": "getDeploymentSettingsInGit_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment Settings.",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Modify deployment settings",
        "description": "Modifies deployment settings for a project.",
        "operationId": "modifyDeploymentSettingsInGit_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "Git reference to use when modifying deployment settings.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentSettingsInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Settings were modified, contains the updated Deployment Settings",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/deploymentsettings/{id}": {
      "get": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Get deployment settings by ID.",
        "operationId": "getDeploymentSettingsByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the DeploymentSettings to load",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          }
        },
        "deprecated": true
      }
    },
    "/{spaceId}/deploymentsettings/{projectId}": {
      "put": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Modify deployment settings",
        "description": "Modifies deployment settings for a project.",
        "operationId": "modifyDeploymentSettingsInDatabaseBySpace_Legacy0",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentSettingsInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Settings were modified, contains the updated Deployment Settings",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        },
        "deprecated": true
      }
    },
    "/{spaceId}/projects/{projectId}/deploymentsettings": {
      "get": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Get deployment settings by ID.",
        "operationId": "getDeploymentSettingsInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment Settings.",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Modify deployment settings",
        "description": "Modifies deployment settings for a project.",
        "operationId": "modifyDeploymentSettingsInDatabaseBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentSettingsInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Settings were modified, contains the updated Deployment Settings",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/deploymentsettings": {
      "get": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Get deployment settings by ID.",
        "operationId": "getDeploymentSettingsInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment Settings.",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Modify deployment settings",
        "description": "Modifies deployment settings for a project.",
        "operationId": "modifyDeploymentSettingsInGitBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "Git reference to use when modifying deployment settings.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentSettingsInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Settings were modified, contains the updated Deployment Settings",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/deploymentsettings/{id}": {
      "get": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Get deployment settings by ID.",
        "operationId": "getDeploymentSettingsById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the DeploymentSettings to load",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          }
        },
        "deprecated": true
      }
    },
    "/spaces/{spaceIdentifier}/deploymentsettings/{projectId}": {
      "put": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Modify deployment settings",
        "description": "Modifies deployment settings for a project.",
        "operationId": "modifyDeploymentSettingsInDatabase_Legacy0",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentSettingsInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Settings were modified, contains the updated Deployment Settings",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        },
        "deprecated": true
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/deploymentsettings": {
      "get": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Get deployment settings by ID.",
        "operationId": "getDeploymentSettingsInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment Settings.",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Modify deployment settings",
        "description": "Modifies deployment settings for a project.",
        "operationId": "modifyDeploymentSettingsInDatabase",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentSettingsInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Settings were modified, contains the updated Deployment Settings",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/deploymentsettings": {
      "get": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Get deployment settings by ID.",
        "operationId": "getDeploymentSettingsInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment Settings.",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DeploymentSettings"
        ],
        "summary": "Modify deployment settings",
        "description": "Modifies deployment settings for a project.",
        "operationId": "modifyDeploymentSettingsInGit",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "Git reference to use when modifying deployment settings.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentSettingsInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Deployment Settings were modified, contains the updated Deployment Settings",
            "schema": {
              "$ref": "#/definitions/DeploymentSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results will be sorted alphabetically by name.",
        "operationId": "getDeploymentTargets_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "commStyles",
            "description": "List of communication styles which if specified, filters the result to only include Deployment Targets with matching communication styles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "description": "List of deployment target types which if specified, filters the result to only include Deployment Targets with matching types.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environmentIds",
            "description": "List of Environment IDs which if specified, filters the result to only include Deployment Targets with matching Environment IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "description": "List of health statuses which if specified, filters the result to only include Deployment Targets with matching health statuses.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Deployment Target IDs which if specified, filters the result to only include Deployment Targets with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "A filter to return only disabled/enabled Deployment Targets",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a deployment target to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "description": "List of operating system names which if specified, filters the result to only include Deployment Targets with matching operating systems.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "description": "List of roles which if specified, filters the result to only include Deployment Targets with matching roles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "description": "List of shell names which if specified, filters the result to only include Deployment Targets with matching shells.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "targetTags",
            "description": "List of Target Tags which if specified, filters the result to only include Deployment Targets with matching Target Tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "description": "List of Tenant IDs which if specified, filters the result to only include Deployment Targets with matching Tenant IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "description": "List of Tenant Tags which if specified, filters the result to only include Deployment Targets with matching Tenant Tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of alphabetically sorted deployment targets that matched the request.",
            "schema": {
              "$ref": "#/definitions/MachineResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Create a MachineResource",
        "description": "Creates a new deployment target.",
        "operationId": "createDeploymentTarget_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentTargetCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/MachineResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines/all": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of Deployment Targets",
        "description": "Lists all of the Deployment Targets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllDeploymentTargets_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Machine resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "thumbprint",
            "description": "A thumbprint used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Deployment Targets",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/MachineResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines/all/v1": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of Deployment Targets",
        "description": "Lists all of the Deployment Targets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllDeploymentTargetsV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Machine resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "thumbprint",
            "description": "A thumbprint used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Deployment Targets",
            "schema": {
              "$ref": "#/definitions/GetAllDeploymentTargetsResponse"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines/discover": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Interrogate a deployment target for communication details so that it may be added to the installation.",
        "operationId": "discoverDeploymentTarget_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "host",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "port",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "proxyId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "type",
            "type": "string",
            "enum": [
              "TentaclePassive",
              "TentacleActive",
              "Ssh"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The machine which was discovered",
            "schema": {
              "$ref": "#/definitions/MachineBasedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines/operatingsystem/names/all": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get all operating system names for deployment targets.",
        "operationId": "getDeploymentTargetOperatingSystemNamesAll_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The operating system names",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines/operatingsystem/shells/all": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get all operating system shell names for deployment targets.",
        "operationId": "getDeploymentTargetOperatingSystemShellsAll_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The operating system shell names",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines/v2": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results are sorted by health status, healthiest first, then alphabetically by name.",
        "operationId": "getDeploymentTargetsV2_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "commStyles",
            "description": "List of communication styles which if specified, filters the result to only include Deployment Targets with matching communication styles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "description": "List of deployment target types which if specified, filters the result to only include Deployment Targets with matching types.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environmentIds",
            "description": "List of Environment IDs which if specified, filters the result to only include Deployment Targets with matching Environment IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "description": "List of health statuses which if specified, filters the result to only include Deployment Targets with matching health statuses.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Deployment Target IDs which if specified, filters the result to only include Deployment Targets with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "A filter to return only disabled/enabled Deployment Targets",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a deployment target to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "description": "List of operating system names which if specified, filters the result to only include Deployment Targets with matching operating systems.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "description": "List of roles which if specified, filters the result to only include Deployment Targets with matching roles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "description": "List of shell names which if specified, filters the result to only include Deployment Targets with matching shells.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "targetTags",
            "description": "List of Target Tags which if specified, filters the result to only include Deployment Targets with matching Target Tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "description": "List of Tenant IDs which if specified, filters the result to only include Deployment Targets with matching Tenant IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "description": "List of Tenant Tags which if specified, filters the result to only include Deployment Targets with matching Tenant Tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of alphabetically sorted deployment targets that matched the request.",
            "schema": {
              "$ref": "#/definitions/GetDeploymentTargetsResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines/{id}": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get an existing Deployment Target.",
        "operationId": "getDeploymentTargetById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Machine.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The Deployment Target resource to return.",
            "schema": {
              "$ref": "#/definitions/MachineResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Delete an existing Deployment Target",
        "operationId": "deleteDeploymentTarget_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment Target to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines/{id}/latestdeployments": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of the latest deployments by project for the given Deployment Target",
        "operationId": "getLatestDeploymentPerProjectForDeploymentTarget_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment Target",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of latest deployments per project for the Deployment Target",
            "schema": {
              "$ref": "#/definitions/LatestProjectDeploymentPaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines/{id}/tasks": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of Tasks for the given Deployment Target",
        "description": "Get a history of related Tasks (ie. Deployments) for a Deployment Target.",
        "operationId": "getTasksForDeploymentTarget_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment Target",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "type",
            "description": "The type of Task to retrieve. If left blank, all Tasks are retrieved",
            "type": "string",
            "enum": [
              "Deployment",
              "RunbookRun"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Tasks for the Deployment Target",
            "schema": {
              "$ref": "#/definitions/TaskResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines/{id}/tasks/v1": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of Tasks for the given Deployment Target",
        "description": "Get a history of related Tasks (ie. Deployments) for a Deployment Target.",
        "operationId": "getTasksForDeploymentTargetV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment Target",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "type",
            "description": "The type of Task to retrieve. If left blank, all Tasks are retrieved",
            "type": "string",
            "enum": [
              "Deployment",
              "RunbookRun"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Tasks for the Deployment Target",
            "schema": {
              "$ref": "#/definitions/GetTasksForDeploymentTargetResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines/{machineid}": {
      "put": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Modify an existing Deployment Target (identified by ID).",
        "operationId": "modifyDeploymentTarget_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "machineid",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentTargetCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The MachineResource following requested changes.",
            "schema": {
              "$ref": "#/definitions/MachineResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines/{machineId}/singlyScopedVariableDetails": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "List all the variable set names (projects and library variable sets) that have variables that are scoped to only the given machine",
        "operationId": "getVariablesScopedToSingleDeploymentTarget_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "machineId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The names of LibraryVariableSets and VariableSets which contain one or more variables scoped to the requested machine. Along with boolean indication to show that there are unviewable/editable projects/libraries which also contain scoped variables.",
            "schema": {
              "$ref": "#/definitions/GetVariablesScopedToSingleDeploymentTargetResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results will be sorted alphabetically by name.",
        "operationId": "getDeploymentTargetsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "description": "List of communication styles which if specified, filters the result to only include Deployment Targets with matching communication styles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "description": "List of deployment target types which if specified, filters the result to only include Deployment Targets with matching types.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environmentIds",
            "description": "List of Environment IDs which if specified, filters the result to only include Deployment Targets with matching Environment IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "description": "List of health statuses which if specified, filters the result to only include Deployment Targets with matching health statuses.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Deployment Target IDs which if specified, filters the result to only include Deployment Targets with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "A filter to return only disabled/enabled Deployment Targets",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a deployment target to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "description": "List of operating system names which if specified, filters the result to only include Deployment Targets with matching operating systems.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "description": "List of roles which if specified, filters the result to only include Deployment Targets with matching roles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "description": "List of shell names which if specified, filters the result to only include Deployment Targets with matching shells.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "targetTags",
            "description": "List of Target Tags which if specified, filters the result to only include Deployment Targets with matching Target Tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "description": "List of Tenant IDs which if specified, filters the result to only include Deployment Targets with matching Tenant IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "description": "List of Tenant Tags which if specified, filters the result to only include Deployment Targets with matching Tenant Tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of alphabetically sorted deployment targets that matched the request.",
            "schema": {
              "$ref": "#/definitions/MachineResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Create a MachineResource",
        "description": "Creates a new deployment target.",
        "operationId": "createDeploymentTargetBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentTargetCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/MachineResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines/all": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of Deployment Targets",
        "description": "Lists all of the Deployment Targets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllDeploymentTargetsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Machine resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "thumbprint",
            "description": "A thumbprint used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Deployment Targets",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/MachineResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines/all/v1": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of Deployment Targets",
        "description": "Lists all of the Deployment Targets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllDeploymentTargetsV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Machine resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "thumbprint",
            "description": "A thumbprint used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Deployment Targets",
            "schema": {
              "$ref": "#/definitions/GetAllDeploymentTargetsResponse"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines/discover": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Interrogate a deployment target for communication details so that it may be added to the installation.",
        "operationId": "discoverDeploymentTargetBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "host",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "port",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "proxyId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "type",
            "type": "string",
            "enum": [
              "TentaclePassive",
              "TentacleActive",
              "Ssh"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The machine which was discovered",
            "schema": {
              "$ref": "#/definitions/MachineBasedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines/operatingsystem/names/all": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get all operating system names for deployment targets.",
        "operationId": "getDeploymentTargetOperatingSystemNamesAllBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The operating system names",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines/operatingsystem/shells/all": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get all operating system shell names for deployment targets.",
        "operationId": "getDeploymentTargetOperatingSystemShellsAllBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The operating system shell names",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines/v2": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results are sorted by health status, healthiest first, then alphabetically by name.",
        "operationId": "getDeploymentTargetsV2BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "description": "List of communication styles which if specified, filters the result to only include Deployment Targets with matching communication styles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "description": "List of deployment target types which if specified, filters the result to only include Deployment Targets with matching types.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environmentIds",
            "description": "List of Environment IDs which if specified, filters the result to only include Deployment Targets with matching Environment IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "description": "List of health statuses which if specified, filters the result to only include Deployment Targets with matching health statuses.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Deployment Target IDs which if specified, filters the result to only include Deployment Targets with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "A filter to return only disabled/enabled Deployment Targets",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a deployment target to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "description": "List of operating system names which if specified, filters the result to only include Deployment Targets with matching operating systems.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "description": "List of roles which if specified, filters the result to only include Deployment Targets with matching roles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "description": "List of shell names which if specified, filters the result to only include Deployment Targets with matching shells.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "targetTags",
            "description": "List of Target Tags which if specified, filters the result to only include Deployment Targets with matching Target Tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "description": "List of Tenant IDs which if specified, filters the result to only include Deployment Targets with matching Tenant IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "description": "List of Tenant Tags which if specified, filters the result to only include Deployment Targets with matching Tenant Tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of alphabetically sorted deployment targets that matched the request.",
            "schema": {
              "$ref": "#/definitions/GetDeploymentTargetsResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines/{id}": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get an existing Deployment Target.",
        "operationId": "getDeploymentTargetByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space that contains the Machine.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Machine.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The Deployment Target resource to return.",
            "schema": {
              "$ref": "#/definitions/MachineResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Delete an existing Deployment Target",
        "operationId": "deleteDeploymentTargetBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The SpaceId of the deployment target to delete.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment Target to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines/{id}/latestdeployments": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of the latest deployments by project for the given Deployment Target",
        "operationId": "getLatestDeploymentPerProjectForDeploymentTargetBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment Target",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of latest deployments per project for the Deployment Target",
            "schema": {
              "$ref": "#/definitions/LatestProjectDeploymentPaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines/{id}/tasks": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of Tasks for the given Deployment Target",
        "description": "Get a history of related Tasks (ie. Deployments) for a Deployment Target.",
        "operationId": "getTasksForDeploymentTargetBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment Target",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "type",
            "description": "The type of Task to retrieve. If left blank, all Tasks are retrieved",
            "type": "string",
            "enum": [
              "Deployment",
              "RunbookRun"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Tasks for the Deployment Target",
            "schema": {
              "$ref": "#/definitions/TaskResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines/{id}/tasks/v1": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of Tasks for the given Deployment Target",
        "description": "Get a history of related Tasks (ie. Deployments) for a Deployment Target.",
        "operationId": "getTasksForDeploymentTargetV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment Target",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "type",
            "description": "The type of Task to retrieve. If left blank, all Tasks are retrieved",
            "type": "string",
            "enum": [
              "Deployment",
              "RunbookRun"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Tasks for the Deployment Target",
            "schema": {
              "$ref": "#/definitions/GetTasksForDeploymentTargetResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines/{machineid}": {
      "put": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Modify an existing Deployment Target (identified by ID).",
        "operationId": "modifyDeploymentTargetBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "machineid",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentTargetCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The MachineResource following requested changes.",
            "schema": {
              "$ref": "#/definitions/MachineResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines/{machineId}/singlyScopedVariableDetails": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "List all the variable set names (projects and library variable sets) that have variables that are scoped to only the given machine",
        "operationId": "getVariablesScopedToSingleDeploymentTargetBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "machineId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The names of LibraryVariableSets and VariableSets which contain one or more variables scoped to the requested machine. Along with boolean indication to show that there are unviewable/editable projects/libraries which also contain scoped variables.",
            "schema": {
              "$ref": "#/definitions/GetVariablesScopedToSingleDeploymentTargetResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results will be sorted alphabetically by name.",
        "operationId": "getDeploymentTargets",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "description": "List of communication styles which if specified, filters the result to only include Deployment Targets with matching communication styles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "description": "List of deployment target types which if specified, filters the result to only include Deployment Targets with matching types.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environmentIds",
            "description": "List of Environment IDs which if specified, filters the result to only include Deployment Targets with matching Environment IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "description": "List of health statuses which if specified, filters the result to only include Deployment Targets with matching health statuses.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Deployment Target IDs which if specified, filters the result to only include Deployment Targets with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "A filter to return only disabled/enabled Deployment Targets",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a deployment target to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "description": "List of operating system names which if specified, filters the result to only include Deployment Targets with matching operating systems.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "description": "List of roles which if specified, filters the result to only include Deployment Targets with matching roles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "description": "List of shell names which if specified, filters the result to only include Deployment Targets with matching shells.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "targetTags",
            "description": "List of Target Tags which if specified, filters the result to only include Deployment Targets with matching Target Tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "description": "List of Tenant IDs which if specified, filters the result to only include Deployment Targets with matching Tenant IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "description": "List of Tenant Tags which if specified, filters the result to only include Deployment Targets with matching Tenant Tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of alphabetically sorted deployment targets that matched the request.",
            "schema": {
              "$ref": "#/definitions/MachineResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Create a MachineResource",
        "description": "Creates a new deployment target.",
        "operationId": "createDeploymentTarget",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentTargetCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/MachineResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines/all": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of Deployment Targets",
        "description": "Lists all of the Deployment Targets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllDeploymentTargets",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Machine resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "thumbprint",
            "description": "A thumbprint used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Deployment Targets",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/MachineResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines/all/v1": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of Deployment Targets",
        "description": "Lists all of the Deployment Targets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllDeploymentTargetsV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Machine resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "thumbprint",
            "description": "A thumbprint used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Deployment Targets",
            "schema": {
              "$ref": "#/definitions/GetAllDeploymentTargetsResponse"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines/discover": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Interrogate a deployment target for communication details so that it may be added to the installation.",
        "operationId": "discoverDeploymentTarget",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "host",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "port",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "proxyId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "type",
            "type": "string",
            "enum": [
              "TentaclePassive",
              "TentacleActive",
              "Ssh"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The machine which was discovered",
            "schema": {
              "$ref": "#/definitions/MachineBasedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines/operatingsystem/names/all": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get all operating system names for deployment targets.",
        "operationId": "getDeploymentTargetOperatingSystemNamesAll",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The operating system names",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines/operatingsystem/shells/all": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get all operating system shell names for deployment targets.",
        "operationId": "getDeploymentTargetOperatingSystemShellsAll",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The operating system shell names",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines/v2": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results are sorted by health status, healthiest first, then alphabetically by name.",
        "operationId": "getDeploymentTargetsV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "description": "List of communication styles which if specified, filters the result to only include Deployment Targets with matching communication styles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "description": "List of deployment target types which if specified, filters the result to only include Deployment Targets with matching types.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environmentIds",
            "description": "List of Environment IDs which if specified, filters the result to only include Deployment Targets with matching Environment IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "description": "List of health statuses which if specified, filters the result to only include Deployment Targets with matching health statuses.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Deployment Target IDs which if specified, filters the result to only include Deployment Targets with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "A filter to return only disabled/enabled Deployment Targets",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a deployment target to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "description": "List of operating system names which if specified, filters the result to only include Deployment Targets with matching operating systems.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "description": "List of roles which if specified, filters the result to only include Deployment Targets with matching roles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "description": "List of shell names which if specified, filters the result to only include Deployment Targets with matching shells.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "targetTags",
            "description": "List of Target Tags which if specified, filters the result to only include Deployment Targets with matching Target Tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "description": "List of Tenant IDs which if specified, filters the result to only include Deployment Targets with matching Tenant IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "description": "List of Tenant Tags which if specified, filters the result to only include Deployment Targets with matching Tenant Tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of alphabetically sorted deployment targets that matched the request.",
            "schema": {
              "$ref": "#/definitions/GetDeploymentTargetsResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines/{id}": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get an existing Deployment Target.",
        "operationId": "getDeploymentTargetById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Machine.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The Deployment Target resource to return.",
            "schema": {
              "$ref": "#/definitions/MachineResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Delete an existing Deployment Target",
        "operationId": "deleteDeploymentTarget",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment Target to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines/{id}/latestdeployments": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of the latest deployments by project for the given Deployment Target",
        "operationId": "getLatestDeploymentPerProjectForDeploymentTarget",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment Target",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of latest deployments per project for the Deployment Target",
            "schema": {
              "$ref": "#/definitions/LatestProjectDeploymentPaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines/{id}/tasks": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of Tasks for the given Deployment Target",
        "description": "Get a history of related Tasks (ie. Deployments) for a Deployment Target.",
        "operationId": "getTasksForDeploymentTarget",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment Target",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "type",
            "description": "The type of Task to retrieve. If left blank, all Tasks are retrieved",
            "type": "string",
            "enum": [
              "Deployment",
              "RunbookRun"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Tasks for the Deployment Target",
            "schema": {
              "$ref": "#/definitions/TaskResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines/{id}/tasks/v1": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Get a list of Tasks for the given Deployment Target",
        "description": "Get a history of related Tasks (ie. Deployments) for a Deployment Target.",
        "operationId": "getTasksForDeploymentTargetV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Deployment Target",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "type",
            "description": "The type of Task to retrieve. If left blank, all Tasks are retrieved",
            "type": "string",
            "enum": [
              "Deployment",
              "RunbookRun"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Tasks for the Deployment Target",
            "schema": {
              "$ref": "#/definitions/GetTasksForDeploymentTargetResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines/{machineid}": {
      "put": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "Modify an existing Deployment Target (identified by ID).",
        "operationId": "modifyDeploymentTarget",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "machineid",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDeploymentTargetCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The MachineResource following requested changes.",
            "schema": {
              "$ref": "#/definitions/MachineResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines/{machineId}/singlyScopedVariableDetails": {
      "get": {
        "tags": [
          "DeploymentTargets"
        ],
        "summary": "List all the variable set names (projects and library variable sets) that have variables that are scoped to only the given machine",
        "operationId": "getVariablesScopedToSingleDeploymentTarget",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "machineId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The names of LibraryVariableSets and VariableSets which contain one or more variables scoped to the requested machine. Along with boolean indication to show that there are unviewable/editable projects/libraries which also contain scoped variables.",
            "schema": {
              "$ref": "#/definitions/GetVariablesScopedToSingleDeploymentTargetResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deploymenttargettags": {
      "get": {
        "tags": [
          "DeploymentTargetTags"
        ],
        "summary": "Get DeploymentTargetTags by DeploymentTargetTag IDs and Machine ID (deployment target ID).",
        "description": "Gets a paginated list of DeploymentTargetTag.",
        "operationId": "getDeploymentTargetTags_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "machineIds",
            "description": "The Machine ID to filter by.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tags",
            "description": "The DeploymentTargetTag IDs to filter by.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested DeploymentTargetTags.",
            "schema": {
              "$ref": "#/definitions/GetDeploymentTargetTagsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "DeploymentTargetTags"
        ],
        "summary": "Create a new DeploymentTargetTag",
        "operationId": "createDeploymentTargetTag_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentTargetTagCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentTargetTagResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deploymentTargetTags/{tag}": {
      "get": {
        "tags": [
          "DeploymentTargetTags"
        ],
        "summary": "Get a DeploymentTargetTag by ID or Slug",
        "operationId": "getDeploymentTargetTagByTag_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "tag",
            "description": "ID or Slug of the DeploymentTargetTag",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested DeploymentTargetTag",
            "schema": {
              "$ref": "#/definitions/GetDeploymentTargetTagByTagResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deploymenttargettags/{tag}": {
      "delete": {
        "tags": [
          "DeploymentTargetTags"
        ],
        "summary": "Delete a DeploymentTargetTag.",
        "operationId": "deleteDeploymentTargetTag_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "tag",
            "description": "The Tag of the DeploymentTargetTag to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/deploymenttargettags": {
      "get": {
        "tags": [
          "DeploymentTargetTags"
        ],
        "summary": "Get DeploymentTargetTags by DeploymentTargetTag IDs and Machine ID (deployment target ID).",
        "description": "Gets a paginated list of DeploymentTargetTag.",
        "operationId": "getDeploymentTargetTagsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the Space to which the DeploymentTargetTags belong.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "machineIds",
            "description": "The Machine ID to filter by.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tags",
            "description": "The DeploymentTargetTag IDs to filter by.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested DeploymentTargetTags.",
            "schema": {
              "$ref": "#/definitions/GetDeploymentTargetTagsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "DeploymentTargetTags"
        ],
        "summary": "Create a new DeploymentTargetTag",
        "operationId": "createDeploymentTargetTagBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space for the DeploymentTargetTag",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentTargetTagCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentTargetTagResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/deploymentTargetTags/{tag}": {
      "get": {
        "tags": [
          "DeploymentTargetTags"
        ],
        "summary": "Get a DeploymentTargetTag by ID or Slug",
        "operationId": "getDeploymentTargetTagByTagBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tag",
            "description": "ID or Slug of the DeploymentTargetTag",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested DeploymentTargetTag",
            "schema": {
              "$ref": "#/definitions/GetDeploymentTargetTagByTagResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/deploymenttargettags/{tag}": {
      "delete": {
        "tags": [
          "DeploymentTargetTags"
        ],
        "summary": "Delete a DeploymentTargetTag.",
        "operationId": "deleteDeploymentTargetTagBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tag",
            "description": "The Tag of the DeploymentTargetTag to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/deploymenttargettags": {
      "get": {
        "tags": [
          "DeploymentTargetTags"
        ],
        "summary": "Get DeploymentTargetTags by DeploymentTargetTag IDs and Machine ID (deployment target ID).",
        "description": "Gets a paginated list of DeploymentTargetTag.",
        "operationId": "getDeploymentTargetTags",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "machineIds",
            "description": "The Machine ID to filter by.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tags",
            "description": "The DeploymentTargetTag IDs to filter by.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested DeploymentTargetTags.",
            "schema": {
              "$ref": "#/definitions/GetDeploymentTargetTagsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "DeploymentTargetTags"
        ],
        "summary": "Create a new DeploymentTargetTag",
        "operationId": "createDeploymentTargetTag",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentTargetTagCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateDeploymentTargetTagResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/deploymentTargetTags/{tag}": {
      "get": {
        "tags": [
          "DeploymentTargetTags"
        ],
        "summary": "Get a DeploymentTargetTag by ID or Slug",
        "operationId": "getDeploymentTargetTagByTag",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tag",
            "description": "ID or Slug of the DeploymentTargetTag",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested DeploymentTargetTag",
            "schema": {
              "$ref": "#/definitions/GetDeploymentTargetTagByTagResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/deploymenttargettags/{tag}": {
      "delete": {
        "tags": [
          "DeploymentTargetTags"
        ],
        "summary": "Delete a DeploymentTargetTag.",
        "operationId": "deleteDeploymentTargetTag",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tag",
            "description": "The Tag of the DeploymentTargetTag to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deprecations/toggle": {
      "post": {
        "tags": [
          "Deprecations"
        ],
        "summary": "Toggle a deprecation on or off in Octopus Server. Used to test the impact of deprecations",
        "operationId": "toggleDeprecation",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ToggleDeprecationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Toggle has been deprecated",
            "schema": {
              "$ref": "#/definitions/ToggleDeprecationResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/deprecations/toggle/v1": {
      "post": {
        "tags": [
          "Deprecations"
        ],
        "summary": "Toggle a deprecation on or off in Octopus Server. Used to test the impact of deprecations",
        "operationId": "toggleDeprecationV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ToggleDeprecationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Toggle has been deprecated",
            "schema": {
              "$ref": "#/definitions/ToggleDeprecationResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/externalgroups/directoryServices": {
      "get": {
        "tags": [
          "DirectoryServices"
        ],
        "summary": "Search for Active Directory groups",
        "description": "Search for Active Directory groups",
        "operationId": "getListSecurityGroups",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/externalusers/directoryServices": {
      "get": {
        "tags": [
          "DirectoryServices"
        ],
        "summary": "Search for Active Directory users",
        "description": "Search for Active Directory users",
        "operationId": "getUserLookup",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/dynamic-extensions/features/metadata": {
      "get": {
        "tags": [
          "DynamicExtensions"
        ],
        "summary": "Request the current dynamic extensions feature metadata",
        "operationId": "getDynamicExtensionsFeaturesMetadata",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The current dynamic extensions feature metadata",
            "schema": {
              "$ref": "#/definitions/DynamicExtensionsFeaturesMetadataResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/dynamic-extensions/features/values": {
      "get": {
        "tags": [
          "DynamicExtensions"
        ],
        "summary": "Request the current dynamic extensions feature values",
        "operationId": "getDynamicExtensionsFeaturesValues",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The current dynamic extensions feature values",
            "schema": {
              "$ref": "#/definitions/DynamicExtensionsFeaturesValuesResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "DynamicExtensions"
        ],
        "summary": "Modify the current dynamic extensions feature values.",
        "operationId": "setDynamicExtensionsFeaturesValues",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/SetDynamicExtensionsFeaturesValuesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The new dynamic extensions feature values",
            "schema": {
              "$ref": "#/definitions/DynamicExtensionsFeaturesValuesResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/environments": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a list of Environments.",
        "description": "Lists all of the environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment.",
        "operationId": "getEnvironments_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "Environment Ids to filter results to only Environments with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Filters the returned environments by the specified `name` fragment. Left for backwards compatibility; prefer PartialName.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters the documents using the specified `partialName` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Environments",
            "schema": {
              "$ref": "#/definitions/EnvironmentResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Environments"
        ],
        "summary": "Create a new environment.",
        "operationId": "createEnvironment_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateEnvironmentCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/EnvironmentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/environments/all": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a list of Environments",
        "description": "Lists the name and ID of all of the environments in the supplied Space. The results will be sorted by the `SortOrder` field on each environment.",
        "operationId": "getAllEnvironments_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "channelId",
            "description": "A Channel Id used to filter a query.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Deployment Environment resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A project Id used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Environments",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/environments/all/v1": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a list of Environments",
        "description": "Lists the name and ID of all of the environments in the supplied Space. The results will be sorted by the `SortOrder` field on each environment.",
        "operationId": "getAllEnvironmentsV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "channelId",
            "description": "A Channel Id used to filter a query.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Deployment Environment resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A project Id used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Environments",
            "schema": {
              "$ref": "#/definitions/GetAllEnvironmentsResponse"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/environments/sortorder": {
      "put": {
        "tags": [
          "Environments"
        ],
        "description": "Takes an array of environment IDs as the request body, uses the order of items in the array to sort the environments on the server. The ID of every environment must be specified.",
        "operationId": "sortEnvironments_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/environments/summary": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "List all environments, including a summary of machine information",
        "operationId": "getEnvironmentsSummary_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environmentTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "hideEmptyEnvironments",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "machinePartialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "targetTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the machines et al associated with a given environment.",
            "schema": {
              "$ref": "#/definitions/EnvironmentsSummaryResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/environments/v1": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a list of Environments.",
        "description": "Lists all of the environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment.",
        "operationId": "getEnvironmentsV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "Environment Ids to filter results to only Environments with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Filters the returned environments by the specified `name` fragment. Left for backwards compatibility; prefer PartialName.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters the documents using the specified `partialName` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Environments",
            "schema": {
              "$ref": "#/definitions/GetEnvironmentsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/environments/{environmentId}": {
      "put": {
        "tags": [
          "Environments"
        ],
        "summary": "Modify an existing environment.",
        "operationId": "modifyEnvironment_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyEnvironmentCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The environment after modifications have been applied.",
            "schema": {
              "$ref": "#/definitions/EnvironmentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/environments/{environmentId}/metadata": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get the environment custom settings metadata from the extensions.",
        "operationId": "getEnvironmentMetadata_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "environmentId",
            "description": "The Id of the environment for which metadata is to be retrieved",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Environment Metadata",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/DeploymentEnvironmentSettingsMetadata"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/environments/{environmentId}/singlyScopedVariableDetails": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "List all the variable set names (projects and library variable sets) that have variables that are scoped to only the given environment",
        "operationId": "getVariablesScopedToSingleEnvironment_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The names of LibraryVariableSets and VariableSets which contain one or more variables scoped to the requested environment. Along with boolean indication to show that there are unviewable/editable projects/libraries which also contain scoped variables.",
            "schema": {
              "$ref": "#/definitions/VariablesScopedToDocumentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/environments/{id}": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a specific Deployment Environment",
        "operationId": "getDeploymentEnvironment_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Environment to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment Environment",
            "schema": {
              "$ref": "#/definitions/EnvironmentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Environments"
        ],
        "summary": "Delete an existing Environment",
        "operationId": "deleteDeploymentEnvironment_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Environment to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/environments/{id}/machines": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Return the list of machines in an environment that matches the filters requested by the user.",
        "operationId": "getEnvironmentMachines_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items per page. Defaults to 20",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "targetTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The lists of all machines that belong to the given environment, and matches any specified filters.",
            "schema": {
              "$ref": "#/definitions/MachineResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a list of Environments.",
        "description": "Lists all of the environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment.",
        "operationId": "getEnvironmentsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Environment Ids to filter results to only Environments with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Filters the returned environments by the specified `name` fragment. Left for backwards compatibility; prefer PartialName.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters the documents using the specified `partialName` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Environments",
            "schema": {
              "$ref": "#/definitions/EnvironmentResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Environments"
        ],
        "summary": "Create a new environment.",
        "operationId": "createEnvironmentBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateEnvironmentCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/EnvironmentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments/all": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a list of Environments",
        "description": "Lists the name and ID of all of the environments in the supplied Space. The results will be sorted by the `SortOrder` field on each environment.",
        "operationId": "getAllEnvironmentsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channelId",
            "description": "A Channel Id used to filter a query.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Deployment Environment resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A project Id used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Environments",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments/all/v1": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a list of Environments",
        "description": "Lists the name and ID of all of the environments in the supplied Space. The results will be sorted by the `SortOrder` field on each environment.",
        "operationId": "getAllEnvironmentsV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channelId",
            "description": "A Channel Id used to filter a query.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Deployment Environment resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A project Id used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Environments",
            "schema": {
              "$ref": "#/definitions/GetAllEnvironmentsResponse"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments/sortorder": {
      "put": {
        "tags": [
          "Environments"
        ],
        "description": "Takes an array of environment IDs as the request body, uses the order of items in the array to sort the environments on the server. The ID of every environment must be specified.",
        "operationId": "sortEnvironmentsBySpace",
        "consumes": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/{spaceId}/environments/summary": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "List all environments, including a summary of machine information",
        "operationId": "getEnvironmentsSummaryBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environmentTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "hideEmptyEnvironments",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "machinePartialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "targetTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the machines et al associated with a given environment.",
            "schema": {
              "$ref": "#/definitions/EnvironmentsSummaryResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments/summary/v2": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "List all environments, including a summary of machine information",
        "operationId": "getEnvironmentsSummaryV2BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environmentTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "hideEmptyEnvironments",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "machinePartialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "targetTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "type",
            "description": "Filters the environment summaries using the specified environment EnvironmentType",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the machines et al associated with a given environment.",
            "schema": {
              "$ref": "#/definitions/GetEnvironmentsSummaryResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments/v1": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a list of Environments.",
        "description": "Lists all of the environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment.",
        "operationId": "getEnvironmentsV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Environment Ids to filter results to only Environments with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Filters the returned environments by the specified `name` fragment. Left for backwards compatibility; prefer PartialName.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters the documents using the specified `partialName` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Environments",
            "schema": {
              "$ref": "#/definitions/GetEnvironmentsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments/v2": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "List Static, Parent and Ephemeral Environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment (which is set to a MaxValue integer for Ephemeral Environments).",
        "operationId": "getEnvironmentsV2BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter environments using ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of an Environment to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters the documents using the specified `partialName` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "type",
            "description": "Filters the documents using the specified environment EnvironmentType",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/BaseEnvironmentV2ResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments/{environmentId}": {
      "put": {
        "tags": [
          "Environments"
        ],
        "summary": "Modify an existing environment.",
        "operationId": "modifyEnvironmentBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyEnvironmentCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The environment after modifications have been applied.",
            "schema": {
              "$ref": "#/definitions/EnvironmentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments/{environmentId}/metadata": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get the environment custom settings metadata from the extensions.",
        "operationId": "getEnvironmentMetadataBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The Id of the space containing the environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "The Id of the environment for which metadata is to be retrieved",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Environment Metadata",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/DeploymentEnvironmentSettingsMetadata"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments/{environmentId}/singlyScopedVariableDetails": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "List all the variable set names (projects and library variable sets) that have variables that are scoped to only the given environment",
        "operationId": "getVariablesScopedToSingleEnvironmentBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The names of LibraryVariableSets and VariableSets which contain one or more variables scoped to the requested environment. Along with boolean indication to show that there are unviewable/editable projects/libraries which also contain scoped variables.",
            "schema": {
              "$ref": "#/definitions/VariablesScopedToDocumentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments/{id}": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a specific Deployment Environment",
        "operationId": "getDeploymentEnvironmentBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Environment to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment Environment",
            "schema": {
              "$ref": "#/definitions/EnvironmentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Environments"
        ],
        "summary": "Delete an existing Environment",
        "operationId": "deleteDeploymentEnvironmentBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Environment to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments/{id}/machines": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Return the list of machines in an environment that matches the filters requested by the user.",
        "operationId": "getEnvironmentMachinesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items per page. Defaults to 20",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "targetTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The lists of all machines that belong to the given environment, and matches any specified filters.",
            "schema": {
              "$ref": "#/definitions/MachineResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments/{id}/v2": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a specific Static, Parent or Ephemeral Environment by ID",
        "operationId": "getDeploymentEnvironmentV2BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Environment to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Static, Parent or Ephemeral Environment",
            "schema": {
              "$ref": "#/definitions/BaseEnvironmentV2Resource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "List environments available for a project.",
        "operationId": "getProjectEnvironmentsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters the environments by partial name fragment.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "type",
            "description": "Filters the environments by EnvironmentType",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/BaseEnvironmentV2ResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/states/{key}": {
      "delete": {
        "tags": [
          "Environments"
        ],
        "summary": "Delete the environment state entry with the given key for a project/environment (and optionally tenant).",
        "operationId": "deleteProjectEnvironmentStateBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the environment state entry.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the environment state entry belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "The ID of the environment the environment state entry belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "description": "An ID for a Tenant. If supplied, the entry deleted is the one published for the Tenant identified by the ID. If not supplied, the untenanted entry is deleted.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "key",
            "description": "The key of the environment state entry to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/{environmentId}/untenanted/states/{key}": {
      "delete": {
        "tags": [
          "Environments"
        ],
        "summary": "Delete the environment state entry with the given key for a project/environment (and optionally tenant).",
        "operationId": "deleteProjectEnvironmentStateBySpace_Legacy0",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the environment state entry.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the environment state entry belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "The ID of the environment the environment state entry belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "key",
            "description": "The key of the environment state entry to delete.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/DeleteProjectEnvironmentStateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/{environmentId}/urls": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Gets the set of URLs published for a project/environment (and optionally tenant).",
        "operationId": "getProjectEnvironmentUrlsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "An ID for a Tenant. If supplied, will limit the result to URLs published for the Tenant identified by the ID. If not supplied, only untenanted URLs are returned.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested set of environment URLs",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentUrlResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a list of Environments.",
        "description": "Lists all of the environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment.",
        "operationId": "getEnvironments",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Environment Ids to filter results to only Environments with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Filters the returned environments by the specified `name` fragment. Left for backwards compatibility; prefer PartialName.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters the documents using the specified `partialName` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Environments",
            "schema": {
              "$ref": "#/definitions/EnvironmentResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Environments"
        ],
        "summary": "Create a new environment.",
        "operationId": "createEnvironment",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateEnvironmentCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/EnvironmentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/all": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a list of Environments",
        "description": "Lists the name and ID of all of the environments in the supplied Space. The results will be sorted by the `SortOrder` field on each environment.",
        "operationId": "getAllEnvironments",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channelId",
            "description": "A Channel Id used to filter a query.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Deployment Environment resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A project Id used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Environments",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/all/v1": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a list of Environments",
        "description": "Lists the name and ID of all of the environments in the supplied Space. The results will be sorted by the `SortOrder` field on each environment.",
        "operationId": "getAllEnvironmentsV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channelId",
            "description": "A Channel Id used to filter a query.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Deployment Environment resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A project Id used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Environments",
            "schema": {
              "$ref": "#/definitions/GetAllEnvironmentsResponse"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/sortorder": {
      "put": {
        "tags": [
          "Environments"
        ],
        "description": "Takes an array of environment IDs as the request body, uses the order of items in the array to sort the environments on the server. The ID of every environment must be specified.",
        "operationId": "sortEnvironments",
        "consumes": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/summary": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "List all environments, including a summary of machine information",
        "operationId": "getEnvironmentsSummary",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environmentTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "hideEmptyEnvironments",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "machinePartialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "targetTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the machines et al associated with a given environment.",
            "schema": {
              "$ref": "#/definitions/EnvironmentsSummaryResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/summary/v2": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "List all environments, including a summary of machine information",
        "operationId": "getEnvironmentsSummaryV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environmentTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "hideEmptyEnvironments",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "machinePartialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "targetTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "type",
            "description": "Filters the environment summaries using the specified environment EnvironmentType",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the machines et al associated with a given environment.",
            "schema": {
              "$ref": "#/definitions/GetEnvironmentsSummaryResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/v1": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a list of Environments.",
        "description": "Lists all of the environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment.",
        "operationId": "getEnvironmentsV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Environment Ids to filter results to only Environments with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Filters the returned environments by the specified `name` fragment. Left for backwards compatibility; prefer PartialName.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters the documents using the specified `partialName` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Environments",
            "schema": {
              "$ref": "#/definitions/GetEnvironmentsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/v2": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "List Static, Parent and Ephemeral Environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment (which is set to a MaxValue integer for Ephemeral Environments).",
        "operationId": "getEnvironmentsV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter environments using ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of an Environment to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters the documents using the specified `partialName` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "type",
            "description": "Filters the documents using the specified environment EnvironmentType",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/BaseEnvironmentV2ResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/{environmentId}": {
      "put": {
        "tags": [
          "Environments"
        ],
        "summary": "Modify an existing environment.",
        "operationId": "modifyEnvironment",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyEnvironmentCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The environment after modifications have been applied.",
            "schema": {
              "$ref": "#/definitions/EnvironmentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/{environmentId}/metadata": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get the environment custom settings metadata from the extensions.",
        "operationId": "getEnvironmentMetadata",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "The Id of the environment for which metadata is to be retrieved",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Environment Metadata",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/DeploymentEnvironmentSettingsMetadata"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/{environmentId}/singlyScopedVariableDetails": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "List all the variable set names (projects and library variable sets) that have variables that are scoped to only the given environment",
        "operationId": "getVariablesScopedToSingleEnvironment",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The names of LibraryVariableSets and VariableSets which contain one or more variables scoped to the requested environment. Along with boolean indication to show that there are unviewable/editable projects/libraries which also contain scoped variables.",
            "schema": {
              "$ref": "#/definitions/VariablesScopedToDocumentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/{id}": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a specific Deployment Environment",
        "operationId": "getDeploymentEnvironment",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Environment to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment Environment",
            "schema": {
              "$ref": "#/definitions/EnvironmentResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Environments"
        ],
        "summary": "Delete an existing Environment",
        "operationId": "deleteDeploymentEnvironment",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Environment to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/{id}/machines": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Return the list of machines in an environment that matches the filters requested by the user.",
        "operationId": "getEnvironmentMachines",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "roles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items per page. Defaults to 20",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "targetTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The lists of all machines that belong to the given environment, and matches any specified filters.",
            "schema": {
              "$ref": "#/definitions/MachineResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/{id}/v2": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Get a specific Static, Parent or Ephemeral Environment by ID",
        "operationId": "getDeploymentEnvironmentV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Environment to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Static, Parent or Ephemeral Environment",
            "schema": {
              "$ref": "#/definitions/BaseEnvironmentV2Resource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "List environments available for a project.",
        "operationId": "getProjectEnvironments",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters the environments by partial name fragment.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "type",
            "description": "Filters the environments by EnvironmentType",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/BaseEnvironmentV2ResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/states/{key}": {
      "delete": {
        "tags": [
          "Environments"
        ],
        "summary": "Delete the environment state entry with the given key for a project/environment (and optionally tenant).",
        "operationId": "deleteProjectEnvironmentState",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the environment state entry belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "The ID of the environment the environment state entry belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "description": "An ID for a Tenant. If supplied, the entry deleted is the one published for the Tenant identified by the ID. If not supplied, the untenanted entry is deleted.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "key",
            "description": "The key of the environment state entry to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/untenanted/states/{key}": {
      "delete": {
        "tags": [
          "Environments"
        ],
        "summary": "Delete the environment state entry with the given key for a project/environment (and optionally tenant).",
        "operationId": "deleteProjectEnvironmentState_Legacy0",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the environment state entry belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "The ID of the environment the environment state entry belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "key",
            "description": "The key of the environment state entry to delete.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/DeleteProjectEnvironmentStateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/urls": {
      "get": {
        "tags": [
          "Environments"
        ],
        "summary": "Gets the set of URLs published for a project/environment (and optionally tenant).",
        "operationId": "getProjectEnvironmentUrls",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "An ID for a Tenant. If supplied, will limit the result to URLs published for the Tenant identified by the ID. If not supplied, only untenanted URLs are returned.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested set of environment URLs",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentUrlResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/environments/ephemeral/{id}/deprovision": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Deprovision an ephemeral environment",
        "operationId": "deprovisionEphemeralEnvironmentBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the ephemeral environment to deprovision.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Deprovision an ephemeral environment response",
            "schema": {
              "$ref": "#/definitions/DeprovisionEphemeralEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/ephemeral": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Allow the creation of an ephemeral environment in a given space",
        "operationId": "createEphemeralEnvironmentBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateEphemeralEnvironmentCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateEphemeralEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/ephemeral/{environmentId}/deprovision": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Deprovision an ephemeral environment for a specific project",
        "operationId": "deprovisionEphemeralEnvironmentForProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Deprovision an ephemeral environment response",
            "schema": {
              "$ref": "#/definitions/DeprovisionEphemeralEnvironmentForProjectResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/ephemeral/{environmentId}/deprovisioning/mark-successful": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Mark a failed deprovisioning as successful for an ephemeral environment",
        "operationId": "markEphemeralEnvironmentDeprovisioningSuccessfulBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response to mark deprovisioning as successful for an ephemeral environment",
            "schema": {
              "$ref": "#/definitions/MarkEphemeralEnvironmentDeprovisioningSuccessfulResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/ephemeral/{environmentId}/deprovisioning/retry": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Retry deprovisioning an ephemeral environment",
        "operationId": "retryDeprovisioningEphemeralEnvironmentBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response to retry deprovisioning an ephemeral environment",
            "schema": {
              "$ref": "#/definitions/RetryDeprovisioningEphemeralEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/ephemeral/{environmentId}/provisioning/mark-successful": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Mark a failed provisioning as successful for an ephemeral environment",
        "operationId": "markEphemeralEnvironmentProvisioningSuccessfulBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response to mark provisioning as successful for an ephemeral environment",
            "schema": {
              "$ref": "#/definitions/MarkEphemeralEnvironmentProvisioningSuccessfulResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/ephemeral/{environmentId}/provisioning/retry": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Retry provisioning an ephemeral environment",
        "operationId": "retryProvisioningEphemeralEnvironmentBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response to retry provisioning an ephemeral environment",
            "schema": {
              "$ref": "#/definitions/RetryProvisioningEphemeralEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/ephemeral/{id}/status": {
      "get": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Get the status of an ephemeral environment for a given project",
        "operationId": "getEphemeralEnvironmentProjectStatusBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the ephemeral environment whose status to report.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetEphemeralEnvironmentProjectStatusResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/environments/ephemeral/{id}/deprovision": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Deprovision an ephemeral environment",
        "operationId": "deprovisionEphemeralEnvironment",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the ephemeral environment to deprovision.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Deprovision an ephemeral environment response",
            "schema": {
              "$ref": "#/definitions/DeprovisionEphemeralEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Allow the creation of an ephemeral environment in a given space",
        "operationId": "createEphemeralEnvironment",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateEphemeralEnvironmentCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateEphemeralEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral/{environmentId}/deprovision": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Deprovision an ephemeral environment for a specific project",
        "operationId": "deprovisionEphemeralEnvironmentForProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Deprovision an ephemeral environment response",
            "schema": {
              "$ref": "#/definitions/DeprovisionEphemeralEnvironmentForProjectResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral/{environmentId}/deprovisioning/mark-successful": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Mark a failed deprovisioning as successful for an ephemeral environment",
        "operationId": "markEphemeralEnvironmentDeprovisioningSuccessful",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response to mark deprovisioning as successful for an ephemeral environment",
            "schema": {
              "$ref": "#/definitions/MarkEphemeralEnvironmentDeprovisioningSuccessfulResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral/{environmentId}/deprovisioning/retry": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Retry deprovisioning an ephemeral environment",
        "operationId": "retryDeprovisioningEphemeralEnvironment",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response to retry deprovisioning an ephemeral environment",
            "schema": {
              "$ref": "#/definitions/RetryDeprovisioningEphemeralEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral/{environmentId}/provisioning/mark-successful": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Mark a failed provisioning as successful for an ephemeral environment",
        "operationId": "markEphemeralEnvironmentProvisioningSuccessful",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response to mark provisioning as successful for an ephemeral environment",
            "schema": {
              "$ref": "#/definitions/MarkEphemeralEnvironmentProvisioningSuccessfulResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral/{environmentId}/provisioning/retry": {
      "post": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Retry provisioning an ephemeral environment",
        "operationId": "retryProvisioningEphemeralEnvironment",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response to retry provisioning an ephemeral environment",
            "schema": {
              "$ref": "#/definitions/RetryProvisioningEphemeralEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral/{id}/status": {
      "get": {
        "tags": [
          "EphemeralEnvironments"
        ],
        "summary": "Get the status of an ephemeral environment for a given project",
        "operationId": "getEphemeralEnvironmentProjectStatus",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the ephemeral environment whose status to report.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetEphemeralEnvironmentProjectStatusResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/events/archives": {
      "get": {
        "tags": [
          "EventRetention"
        ],
        "summary": "Get the list of archived event files.",
        "operationId": "getArchivedEventFiles",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Archived Event files",
            "schema": {
              "$ref": "#/definitions/ArchivedEventFileResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/events/archives/v1": {
      "get": {
        "tags": [
          "EventRetention"
        ],
        "summary": "Get the list of archived event files.",
        "operationId": "getArchivedEventFilesV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Archived Event files",
            "schema": {
              "$ref": "#/definitions/GetArchivedEventFilesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/events/archives/{fileName}": {
      "get": {
        "tags": [
          "EventRetention"
        ],
        "summary": "Download an archived event file.",
        "operationId": "downloadArchivedEventFile",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "fileName",
            "description": "The file name of archived events file to download.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "EventRetention"
        ],
        "summary": "Delete an archived event file.",
        "operationId": "deleteArchivedEventFile",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "fileName",
            "description": "The file name of archived events file to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/events/archives/{fileName}/v1": {
      "delete": {
        "tags": [
          "EventRetention"
        ],
        "summary": "Delete an archived event file.",
        "operationId": "deleteArchivedEventFileV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "fileName",
            "description": "The file name of archived events file to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Archived Event File has been deleted, containing the filename",
            "schema": {
              "$ref": "#/definitions/DeleteArchivedEventFileResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/events": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "Get a list of events",
        "description": "A list of all audit events collected to date, ordered by the date of the event in descending order. Events can be filtered by various criteria and can be returned as a csv file when the optional parameter 'asCsv' is set to true.",
        "operationId": "getEvents_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "asCsv",
            "description": "Returns list of events as a csv file when set to true",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "documentTypes",
            "description": "The document types to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environments",
            "description": "The environment ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "eventAgents",
            "description": "The event agents to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "eventCategories",
            "description": "The event categories to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "eventGroups",
            "description": "The event groups to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "excludeDifference",
            "description": "Omits the change details of all events when set to true",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "from",
            "description": "Filter events that occurred after this datetime",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "fromAutoId",
            "description": "Filter events after specified autoId",
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "The event ids to be matched, provided as a comma separated list of strings",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeInternalEvents",
            "description": "Exclude the machine-related CRUD events that were added for auto-deploy events",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectGroups",
            "description": "The project group ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projects",
            "description": "The project ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "regarding",
            "description": "The related document ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "regardingAny",
            "description": "The related document ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tags",
            "description": "The canonical tag ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tenants",
            "description": "The tenant ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "to",
            "description": "Filter events that occurred before this datetime",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "toAutoId",
            "description": "Filter events before specified autoId",
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "user",
            "type": "string"
          },
          {
            "in": "query",
            "name": "users",
            "description": "The user ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/events/agents": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "Return the list of event agents.",
        "operationId": "getEventAgents_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested event agents",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EventAgentResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/events/categories": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "List event categories.",
        "operationId": "getEventCategories_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "appliesTo",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Event Categories",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EventCategoryResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/events/documenttypes": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "List subscription event document types.",
        "operationId": "getEventDocumentTypes_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A list of subscription event document types.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/DocumentTypeResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/events/groups": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "List subscription event groups.",
        "operationId": "getEventGroups_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "appliesTo",
            "description": "Filter results to only include Event Groups which are related to the provided string. eg. 'Machine'",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of subscription event groups.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EventGroupResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/events/{id}": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "Get a single event by ID.",
        "operationId": "getEvent_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the event",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested event",
            "schema": {
              "$ref": "#/definitions/EventResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/events": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "Get a list of events",
        "description": "A list of all audit events collected to date, ordered by the date of the event in descending order. Events can be filtered by various criteria and can be returned as a csv file when the optional parameter 'asCsv' is set to true.",
        "operationId": "getEventsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "asCsv",
            "description": "Returns list of events as a csv file when set to true",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "documentTypes",
            "description": "The document types to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environments",
            "description": "The environment ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "eventAgents",
            "description": "The event agents to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "eventCategories",
            "description": "The event categories to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "eventGroups",
            "description": "The event groups to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "excludeDifference",
            "description": "Omits the change details of all events when set to true",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "from",
            "description": "Filter events that occurred after this datetime",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "fromAutoId",
            "description": "Filter events after specified autoId",
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "The event ids to be matched, provided as a comma separated list of strings",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeInternalEvents",
            "description": "Exclude the machine-related CRUD events that were added for auto-deploy events",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectGroups",
            "description": "The project group ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projects",
            "description": "The project ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "regarding",
            "description": "The related document ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "regardingAny",
            "description": "The related document ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tags",
            "description": "The canonical tag ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tenants",
            "description": "The tenant ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "to",
            "description": "Filter events that occurred before this datetime",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "toAutoId",
            "description": "Filter events before specified autoId",
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "user",
            "type": "string"
          },
          {
            "in": "query",
            "name": "users",
            "description": "The user ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/events/agents": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "Return the list of event agents.",
        "operationId": "getEventAgentsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested event agents",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EventAgentResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/events/categories": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "List event categories.",
        "operationId": "getEventCategoriesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "appliesTo",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Event Categories",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EventCategoryResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/events/documenttypes": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "List subscription event document types.",
        "operationId": "getEventDocumentTypesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of subscription event document types.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/DocumentTypeResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/events/groups": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "List subscription event groups.",
        "operationId": "getEventGroupsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "appliesTo",
            "description": "Filter results to only include Event Groups which are related to the provided string. eg. 'Machine'",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of subscription event groups.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EventGroupResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/events/{id}": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "Get a single event by ID.",
        "operationId": "getEventBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the event",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested event",
            "schema": {
              "$ref": "#/definitions/EventResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/events": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "Get a list of events",
        "description": "A list of all audit events collected to date, ordered by the date of the event in descending order. Events can be filtered by various criteria and can be returned as a csv file when the optional parameter 'asCsv' is set to true.",
        "operationId": "getEvents",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "asCsv",
            "description": "Returns list of events as a csv file when set to true",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "documentTypes",
            "description": "The document types to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "environments",
            "description": "The environment ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "eventAgents",
            "description": "The event agents to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "eventCategories",
            "description": "The event categories to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "eventGroups",
            "description": "The event groups to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "excludeDifference",
            "description": "Omits the change details of all events when set to true",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "from",
            "description": "Filter events that occurred after this datetime",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "fromAutoId",
            "description": "Filter events after specified autoId",
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "The event ids to be matched, provided as a comma separated list of strings",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeInternalEvents",
            "description": "Exclude the machine-related CRUD events that were added for auto-deploy events",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectGroups",
            "description": "The project group ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projects",
            "description": "The project ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "regarding",
            "description": "The related document ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "regardingAny",
            "description": "The related document ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tags",
            "description": "The canonical tag ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tenants",
            "description": "The tenant ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "to",
            "description": "Filter events that occurred before this datetime",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "toAutoId",
            "description": "Filter events before specified autoId",
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "user",
            "type": "string"
          },
          {
            "in": "query",
            "name": "users",
            "description": "The user ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/events/agents": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "Return the list of event agents.",
        "operationId": "getEventAgents",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested event agents",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EventAgentResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/events/categories": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "List event categories.",
        "operationId": "getEventCategories",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "appliesTo",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Event Categories",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EventCategoryResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/events/documenttypes": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "List subscription event document types.",
        "operationId": "getEventDocumentTypes",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of subscription event document types.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/DocumentTypeResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/events/groups": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "List subscription event groups.",
        "operationId": "getEventGroups",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "appliesTo",
            "description": "Filter results to only include Event Groups which are related to the provided string. eg. 'Machine'",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of subscription event groups.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EventGroupResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/events/{id}": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "Get a single event by ID.",
        "operationId": "getEvent",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the event",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested event",
            "schema": {
              "$ref": "#/definitions/EventResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/externalsecuritygroupproviders": {
      "get": {
        "tags": [
          "ExternalSecurityGroupProviders"
        ],
        "description": "Lists the authentication providers that support external group lookups and are currently enabled",
        "operationId": "getExternalSecurityGroupProviders",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested External Security Group Providers",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/AuthenticationProviderThatSupportsGroups"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/featuresconfiguration": {
      "get": {
        "tags": [
          "FeaturesConfiguration"
        ],
        "summary": "Get features configuration",
        "description": "Gets the features configuration of the current instance",
        "operationId": "getFeaturesConfiguration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested features configuration",
            "schema": {
              "$ref": "#/definitions/FeaturesConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "FeaturesConfiguration"
        ],
        "summary": "Update features configuration.",
        "description": "Updates the features configuration of the current instance",
        "operationId": "updateFeaturesConfiguration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/UpdateFeaturesConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that features configuration has been updated, containing the new configuration",
            "schema": {
              "$ref": "#/definitions/FeaturesConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/featuretoggles": {
      "get": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Lists all feature toggles within a project",
        "operationId": "listFeatureTogglesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environments",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters results to feature toggles whose name contains this text (case-insensitive substring match).",
            "type": "string"
          },
          {
            "in": "query",
            "name": "rolloutGroups",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/FeatureToggleResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Creates a feature toggle within a project",
        "operationId": "createFeatureToggleBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateFeatureToggleCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/FeatureToggleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/featuretoggles/generate-client-identifier": {
      "post": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Generates a feature toggle client identifier for a given project, environment, and tenant.",
        "operationId": "generateClientIdentifierBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GenerateClientIdentifierCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A generated feature toggle client identifier for a given project, environment, and tenant.",
            "schema": {
              "$ref": "#/definitions/GenerateClientIdentifierResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/featuretoggles/rotate-client-identifier-signing-key": {
      "post": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Rotates the feature toggle client identifier signing keys for a project.",
        "operationId": "rotateFeatureToggleClientIdentifierSigningKeyBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RotateFeatureToggleClientIdentifierSigningKeyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Acks the completion of the rotation of the feature toggle client identifier signing keys for a project.",
            "schema": {
              "$ref": "#/definitions/RotateFeatureToggleClientIdentifierSigningKeyResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/featuretoggles/{id}": {
      "get": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Retrieves a feature toggle by ID",
        "operationId": "getFeatureToggleBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The feature toggle ID. A feature toggle slug is also accepted here as a fallback.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A feature toggle",
            "schema": {
              "$ref": "#/definitions/FeatureToggleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Modifies a feature toggle",
        "operationId": "modifyFeatureToggleBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyFeatureToggleCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A feature toggle",
            "schema": {
              "$ref": "#/definitions/FeatureToggleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Deletes a feature toggle",
        "operationId": "deleteFeatureToggleBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response from deleting a feature and its associated toggles from a project",
            "schema": {
              "$ref": "#/definitions/DeleteFeatureToggleResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/featuretoggles": {
      "get": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Lists all feature toggles within a project",
        "operationId": "listFeatureToggles",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environments",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters results to feature toggles whose name contains this text (case-insensitive substring match).",
            "type": "string"
          },
          {
            "in": "query",
            "name": "rolloutGroups",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/FeatureToggleResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Creates a feature toggle within a project",
        "operationId": "createFeatureToggle",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateFeatureToggleCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/FeatureToggleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/featuretoggles/generate-client-identifier": {
      "post": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Generates a feature toggle client identifier for a given project, environment, and tenant.",
        "operationId": "generateClientIdentifier",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GenerateClientIdentifierCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A generated feature toggle client identifier for a given project, environment, and tenant.",
            "schema": {
              "$ref": "#/definitions/GenerateClientIdentifierResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/featuretoggles/rotate-client-identifier-signing-key": {
      "post": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Rotates the feature toggle client identifier signing keys for a project.",
        "operationId": "rotateFeatureToggleClientIdentifierSigningKey",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RotateFeatureToggleClientIdentifierSigningKeyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Acks the completion of the rotation of the feature toggle client identifier signing keys for a project.",
            "schema": {
              "$ref": "#/definitions/RotateFeatureToggleClientIdentifierSigningKeyResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/featuretoggles/{id}": {
      "get": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Retrieves a feature toggle by ID",
        "operationId": "getFeatureToggle",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The feature toggle ID. A feature toggle slug is also accepted here as a fallback.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A feature toggle",
            "schema": {
              "$ref": "#/definitions/FeatureToggleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Modifies a feature toggle",
        "operationId": "modifyFeatureToggle",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyFeatureToggleCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A feature toggle",
            "schema": {
              "$ref": "#/definitions/FeatureToggleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "FeatureToggles"
        ],
        "summary": "Deletes a feature toggle",
        "operationId": "deleteFeatureToggle",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response from deleting a feature and its associated toggles from a project",
            "schema": {
              "$ref": "#/definitions/DeleteFeatureToggleResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/feeds": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Get a list of feeds",
        "operationId": "getFeeds_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "description": "The feed types to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "The feed ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a feed to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "The partial name of feeds to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Feeds",
            "schema": {
              "$ref": "#/definitions/FeedResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Feeds"
        ],
        "summary": "Create a feed.",
        "operationId": "createFeed_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateFeedCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/FeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/feeds/all": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Get all Feeds",
        "operationId": "getAllFeeds_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Feeds",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/FeedResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/feeds/stats": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Get all feed statistics",
        "operationId": "getFeedStats_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested Feed Statistics",
            "schema": {
              "$ref": "#/definitions/BuiltInFeedStatsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/feeds/{id}": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Get a feed resource by ID.",
        "operationId": "getFeed_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed resource.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Feed",
            "schema": {
              "$ref": "#/definitions/FeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Feeds"
        ],
        "summary": "Modify a feed by ID.",
        "operationId": "modifyFeed_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyFeedCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The response returned from the request to modify a feed.",
            "schema": {
              "$ref": "#/definitions/FeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Feeds"
        ],
        "summary": "Delete an existing Feed.",
        "operationId": "deleteFeed_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Feed.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/feeds/{id}/packages/search": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Search the specified feed for packages based on the provided search term",
        "operationId": "getFeedPackageDescriptorsSearch_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "packageType",
            "description": "The package type to filter results by. Used by feeds that can contain multiple package types. Valid values are ContainerImage and HelmChart.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 20",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "term",
            "description": "The term to search for.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a paginated collection of searched package descriptions",
            "schema": {
              "$ref": "#/definitions/PackageDescriptionResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/feeds/{id}/packages/versions": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "List available package versions for the specified feed and package.",
        "operationId": "getFeedPackageVersions_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "Version number text to filter by.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includePreRelease",
            "description": "Flag to include pre-release versions, defaults to true.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeReleaseNotes",
            "description": "Flag to include release notes, defaults to false.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "packageId",
            "description": "The id of the package.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "preReleaseTag",
            "description": "The semver tag regex pattern to filter by.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "versioningStrategy",
            "description": "The versioning strategy: SemVer or MostRecentlyPublished.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "description": "The range of versions to filter by.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionTagRegex",
            "description": "The version-tag regex, applied to the full version string when set.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a paginated collection of package versions returned from a search",
            "schema": {
              "$ref": "#/definitions/PackageVersionResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/feeds": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Get a list of feeds",
        "operationId": "getFeedsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the Feed.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "description": "The feed types to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "The feed ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a feed to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "The partial name of feeds to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Feeds",
            "schema": {
              "$ref": "#/definitions/FeedResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Feeds"
        ],
        "summary": "Create a feed.",
        "operationId": "createFeedBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space that contains the feed.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateFeedCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/FeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/feeds/all": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Get all Feeds",
        "operationId": "getAllFeedsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the Feed.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Feeds",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/FeedResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/feeds/stats": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Get all feed statistics",
        "operationId": "getFeedStatsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the Feed.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Feed Statistics",
            "schema": {
              "$ref": "#/definitions/BuiltInFeedStatsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/feeds/{id}": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Get a feed resource by ID.",
        "operationId": "getFeedBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space that contains the feed.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed resource.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Feed",
            "schema": {
              "$ref": "#/definitions/FeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Feeds"
        ],
        "summary": "Modify a feed by ID.",
        "operationId": "modifyFeedBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space that contains the feed.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyFeedCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The response returned from the request to modify a feed.",
            "schema": {
              "$ref": "#/definitions/FeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Feeds"
        ],
        "summary": "Delete an existing Feed.",
        "operationId": "deleteFeedBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the Space that contains the Feed.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Feed.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/feeds/{id}/packages/search": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Search the specified feed for packages based on the provided search term",
        "operationId": "getFeedPackageDescriptorsSearchBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the Feed.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "packageType",
            "description": "The package type to filter results by. Used by feeds that can contain multiple package types. Valid values are ContainerImage and HelmChart.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 20",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "term",
            "description": "The term to search for.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a paginated collection of searched package descriptions",
            "schema": {
              "$ref": "#/definitions/PackageDescriptionResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/feeds/{id}/packages/versions": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "List available package versions for the specified feed and package.",
        "operationId": "getFeedPackageVersionsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the Feed.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "Version number text to filter by.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includePreRelease",
            "description": "Flag to include pre-release versions, defaults to true.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeReleaseNotes",
            "description": "Flag to include release notes, defaults to false.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "packageId",
            "description": "The id of the package.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "preReleaseTag",
            "description": "The semver tag regex pattern to filter by.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "versioningStrategy",
            "description": "The versioning strategy: SemVer or MostRecentlyPublished.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "description": "The range of versions to filter by.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionTagRegex",
            "description": "The version-tag regex, applied to the full version string when set.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a paginated collection of package versions returned from a search",
            "schema": {
              "$ref": "#/definitions/PackageVersionResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/feeds": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Get a list of feeds",
        "operationId": "getFeeds",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "feedType",
            "description": "The feed types to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "The feed ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a feed to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "The partial name of feeds to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Feeds",
            "schema": {
              "$ref": "#/definitions/FeedResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Feeds"
        ],
        "summary": "Create a feed.",
        "operationId": "createFeed",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateFeedCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/FeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/feeds/all": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Get all Feeds",
        "operationId": "getAllFeeds",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Feeds",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/FeedResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/feeds/stats": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Get all feed statistics",
        "operationId": "getFeedStats",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Feed Statistics",
            "schema": {
              "$ref": "#/definitions/BuiltInFeedStatsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/feeds/{id}": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Get a feed resource by ID.",
        "operationId": "getFeed",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed resource.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Feed",
            "schema": {
              "$ref": "#/definitions/FeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Feeds"
        ],
        "summary": "Modify a feed by ID.",
        "operationId": "modifyFeed",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "user-Agent",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyFeedCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The response returned from the request to modify a feed.",
            "schema": {
              "$ref": "#/definitions/FeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Feeds"
        ],
        "summary": "Delete an existing Feed.",
        "operationId": "deleteFeed",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Feed.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/feeds/{id}/packages/search": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "Search the specified feed for packages based on the provided search term",
        "operationId": "getFeedPackageDescriptorsSearch",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "packageType",
            "description": "The package type to filter results by. Used by feeds that can contain multiple package types. Valid values are ContainerImage and HelmChart.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 20",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "term",
            "description": "The term to search for.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a paginated collection of searched package descriptions",
            "schema": {
              "$ref": "#/definitions/PackageDescriptionResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/feeds/{id}/packages/versions": {
      "get": {
        "tags": [
          "Feeds"
        ],
        "summary": "List available package versions for the specified feed and package.",
        "operationId": "getFeedPackageVersions",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "Version number text to filter by.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includePreRelease",
            "description": "Flag to include pre-release versions, defaults to true.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeReleaseNotes",
            "description": "Flag to include release notes, defaults to false.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "packageId",
            "description": "The id of the package.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "preReleaseTag",
            "description": "The semver tag regex pattern to filter by.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "versioningStrategy",
            "description": "The versioning strategy: SemVer or MostRecentlyPublished.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "description": "The range of versions to filter by.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionTagRegex",
            "description": "The version-tag regex, applied to the full version string when set.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a paginated collection of package versions returned from a search",
            "schema": {
              "$ref": "#/definitions/PackageVersionResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/github/accounts/install-url": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Get the installation URL for the GitHub App",
        "operationId": "getGitHubAppInstallationUrl",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "redirectUri",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/github/app/settings": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Get the settings for the GitHub App",
        "operationId": "getGitHubAppSettings",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetGitHubAppSettingsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/github/app/status": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Get the status of the registration between Octopus Server and the GitHub App",
        "operationId": "getGitHubAppStatus",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Response containing the status of the registration between Octopus Server and the GitHub App",
            "schema": {
              "$ref": "#/definitions/GetGitHubAppStatusResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/github/installations/updated": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Handle the response from GitHub after an application has been installed or updated.",
        "operationId": "gitHubAppInstallationUpdated",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "installation_id",
            "type": "string"
          },
          {
            "in": "query",
            "name": "redirectUri",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/github/installations/{installationId}/repositories": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Get the GitHub repositories for an installation visible to the current user https://docs.github.com/en/rest/apps/installations?apiVersion=2022-11-28#list-repositories-accessible-to-the-user-access-token",
        "operationId": "getGitHubRepositoriesForInstallation",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "installationId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GitHubRepositoryResponsePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/github/reset-registration": {
      "post": {
        "tags": [
          "GitHub"
        ],
        "summary": "Reset the GitHub app registration for this Octopus instance. This is a destructive command and will break all existing GitHub app connections across the instance. This should only be used as a last resort to recover connectivity with GitHub.",
        "operationId": "resetGitHubAppRegistration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "GitHub app registration was successfully deleted",
            "schema": {
              "$ref": "#/definitions/ResetGitHubAppRegistrationResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/github/search/{accountName}/repositories": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Search for GitHub repositories for an account visible to the current user https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-repositories",
        "operationId": "searchGitHubRepositoriesForAccount",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "accountName",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "keyword",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GitHubRepositoryResponsePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/github/user/app/authorization_status": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Get status of the users current authorization.",
        "operationId": "getGitHubUserAuthorizationStatus",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "includeUserDetails",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "Get the status of the user's current authorization.",
            "schema": {
              "$ref": "#/definitions/GetGitHubUserAuthorizationStatusResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/github/user/app/authorize": {
      "post": {
        "tags": [
          "GitHub"
        ],
        "summary": "Authorize the current user with the Octopus GitHub app",
        "operationId": "authorizeGitHubApp",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/AuthorizeGitHubAppCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "GitHub URL to authorize the GitHub app",
            "schema": {
              "$ref": "#/definitions/AuthorizeGitHubAppResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/github/user/app/exchange-access-code": {
      "post": {
        "tags": [
          "GitHub"
        ],
        "summary": "Exchange a GitHub App authorization code for an access token and store in the instance",
        "operationId": "exchangeAccessCodeForToken",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ExchangeAccessCodeForTokenCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Reports the success of exchanging a GitHub App authorization code for an access token",
            "schema": {
              "$ref": "#/definitions/ExchangeAccessCodeForTokenResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/github/user/app/token": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Exchange a GitHub App authorization code for an access token and store in the instance",
        "operationId": "exchangeGitHubAppCode",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "code",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "redirectUri",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "GitHub"
        ],
        "summary": "Deauthorize the GitHub app for the current user, removing this users GitHub tokens from Octopus",
        "operationId": "deauthorizeGitHubApp",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Deauthorized GitHub app user",
            "schema": {
              "$ref": "#/definitions/DeauthorizeGitHubAppResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/github/user/app/token/refresh": {
      "post": {
        "tags": [
          "GitHub"
        ],
        "summary": "Refresh the GitHub current app user. Refreshing the users token and cached GitHub account details.",
        "operationId": "refreshGitHubAppUser",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "GitHub App user has been successfully refreshed",
            "schema": {
              "$ref": "#/definitions/RefreshGitHubAppUserResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/githubissuetracker/connectivitycheck": {
      "post": {
        "tags": [
          "GitHub"
        ],
        "summary": "Test connectivity to GitHub using the provided credentials",
        "operationId": "gitHubConnectivityCheck",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GitHubConnectivityCheckRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Result of testing connectivity to GitHub",
            "schema": {
              "$ref": "#/definitions/GitHubConnectivityCheckResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/github/connections": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Get GitHub App connections for the space",
        "operationId": "getGitHubAppConnectionsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "All GitHub App connections for the space",
            "schema": {
              "$ref": "#/definitions/GetGitHubAppConnectionsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "GitHub"
        ],
        "summary": "Create a new GitHub App connection for an installation",
        "operationId": "createGitHubAppConnectionBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateGitHubAppConnectionCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "type": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/github/connections/{connectionId}/repositories": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Get the GitHub repositories for the current connection",
        "operationId": "getGitHubRepositoriesForConnectionBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "connectionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "GitHub repositories available for the current connection",
            "schema": {
              "$ref": "#/definitions/GetGitHubRepositoriesForConnectionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/github/connections/{id}": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Get a single GitHub app connection by id",
        "operationId": "getGitHubAppConnectionByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A GitHub app connection",
            "schema": {
              "$ref": "#/definitions/GetGitHubAppConnectionByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "GitHub"
        ],
        "summary": "Update a GitHub App connection with a new set of repositories",
        "operationId": "modifyGitHubAppConnectionBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyGitHubAppConnectionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "GitHub app connection modified result",
            "schema": {
              "$ref": "#/definitions/ModifyGitHubAppConnectionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "GitHub"
        ],
        "summary": "Delete a GitHub App Connection",
        "operationId": "deleteGitHubAppConnectionByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the GitHub connection to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Used to indicate that a GitHub App Connection has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteGitHubAppConnectionByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/github/connections/{id}/recover": {
      "post": {
        "tags": [
          "GitHub"
        ],
        "summary": "Recover GitHub App connection after the registration has changed",
        "operationId": "recoverGitHubAppConnectionBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RecoverGitHubAppConnectionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "GitHub app connection recovery result",
            "schema": {
              "$ref": "#/definitions/RecoverGitHubAppConnectionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/github/connections/{id}/recover-not-found": {
      "post": {
        "tags": [
          "GitHub"
        ],
        "summary": "Recover GitHub App connection after the installation was not found",
        "operationId": "recoverNotFoundGitHubAppConnectionBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RecoverNotFoundGitHubAppConnectionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "GitHub app connection not-found recovery result",
            "schema": {
              "$ref": "#/definitions/RecoverNotFoundGitHubAppConnectionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/github/connections/{id}/refresh": {
      "post": {
        "tags": [
          "GitHub"
        ],
        "summary": "Refresh the GitHub App connection token.",
        "operationId": "refreshGitHubAppConnectionByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "GitHub app connection has been refreshed",
            "schema": {
              "$ref": "#/definitions/RefreshGitHubAppConnectionByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/github/installations": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Get a list of GitHub organisations accessible to the current GitHub OAuth user. Request will fail if the user does not have a valid GitHub OAuth token.",
        "operationId": "getGitHubAppInstallationsForUserBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "excludeConnected",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "List of GitHub organisations accessible to the current GitHub OAuth user",
            "schema": {
              "$ref": "#/definitions/GetGitHubAppInstallationsForUserResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/github/connections": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Get GitHub App connections for the space",
        "operationId": "getGitHubAppConnections",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "All GitHub App connections for the space",
            "schema": {
              "$ref": "#/definitions/GetGitHubAppConnectionsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "GitHub"
        ],
        "summary": "Create a new GitHub App connection for an installation",
        "operationId": "createGitHubAppConnection",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateGitHubAppConnectionCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "type": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/github/connections/{connectionId}/repositories": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Get the GitHub repositories for the current connection",
        "operationId": "getGitHubRepositoriesForConnection",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "connectionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "GitHub repositories available for the current connection",
            "schema": {
              "$ref": "#/definitions/GetGitHubRepositoriesForConnectionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/github/connections/{id}": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Get a single GitHub app connection by id",
        "operationId": "getGitHubAppConnectionById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A GitHub app connection",
            "schema": {
              "$ref": "#/definitions/GetGitHubAppConnectionByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "GitHub"
        ],
        "summary": "Update a GitHub App connection with a new set of repositories",
        "operationId": "modifyGitHubAppConnection",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyGitHubAppConnectionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "GitHub app connection modified result",
            "schema": {
              "$ref": "#/definitions/ModifyGitHubAppConnectionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "GitHub"
        ],
        "summary": "Delete a GitHub App Connection",
        "operationId": "deleteGitHubAppConnectionById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the GitHub connection to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Used to indicate that a GitHub App Connection has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteGitHubAppConnectionByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/github/connections/{id}/recover": {
      "post": {
        "tags": [
          "GitHub"
        ],
        "summary": "Recover GitHub App connection after the registration has changed",
        "operationId": "recoverGitHubAppConnection",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RecoverGitHubAppConnectionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "GitHub app connection recovery result",
            "schema": {
              "$ref": "#/definitions/RecoverGitHubAppConnectionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/github/connections/{id}/recover-not-found": {
      "post": {
        "tags": [
          "GitHub"
        ],
        "summary": "Recover GitHub App connection after the installation was not found",
        "operationId": "recoverNotFoundGitHubAppConnection",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RecoverNotFoundGitHubAppConnectionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "GitHub app connection not-found recovery result",
            "schema": {
              "$ref": "#/definitions/RecoverNotFoundGitHubAppConnectionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/github/connections/{id}/refresh": {
      "post": {
        "tags": [
          "GitHub"
        ],
        "summary": "Refresh the GitHub App connection token.",
        "operationId": "refreshGitHubAppConnectionById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "GitHub app connection has been refreshed",
            "schema": {
              "$ref": "#/definitions/RefreshGitHubAppConnectionByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/github/installations": {
      "get": {
        "tags": [
          "GitHub"
        ],
        "summary": "Get a list of GitHub organisations accessible to the current GitHub OAuth user. Request will fail if the user does not have a valid GitHub OAuth token.",
        "operationId": "getGitHubAppInstallationsForUser",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "excludeConnected",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "List of GitHub organisations accessible to the current GitHub OAuth user",
            "schema": {
              "$ref": "#/definitions/GetGitHubAppInstallationsForUserResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/": {
      "get": {
        "tags": [
          "Home"
        ],
        "description": "Returns a document describing the current Octopus Server and links to other parts of the API.",
        "operationId": "getHome",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RootResource"
            }
          }
        }
      }
    },
    "/{spaceId}": {
      "get": {
        "tags": [
          "Home"
        ],
        "description": "Returns a document describing the specified Space and links to other parts of the API that apply to the Space.",
        "operationId": "getSpaceHomeBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string",
            "pattern": "Spaces-\\d+"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/SpaceRootResource"
            }
          }
        }
      }
    },
    "/icons/all": {
      "get": {
        "tags": [
          "Icons"
        ],
        "summary": "Get details of all icons",
        "operationId": "getAllIcons",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested list of Icons",
            "schema": {
              "$ref": "#/definitions/GetAllIconsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/icons/categories": {
      "get": {
        "tags": [
          "Icons"
        ],
        "summary": "Get all icon categories and icon IDs contained in each category",
        "operationId": "getIconCategories",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested Icon Categories",
            "schema": {
              "$ref": "#/definitions/GetIconCategoriesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceId}/logo/icon": {
      "post": {
        "tags": [
          "Icons"
        ],
        "summary": "Modify the logo of a Space to be a specified icon",
        "operationId": "modifySpaceIconBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the Space to change logo for. Example: 'Space-1'",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifySpaceIconCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Space Icon has been modified",
            "schema": {
              "$ref": "#/definitions/ModifySpaceIconResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/logo/icon": {
      "post": {
        "tags": [
          "Icons"
        ],
        "summary": "Modify the logo of a project to be a specified icon",
        "operationId": "modifyProjectIconBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project to change logo for. Example: 'Projects-1'",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectIconCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Project Icon has been modified",
            "schema": {
              "$ref": "#/definitions/ModifyProjectIconResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tenants/{tenantId}/logo/icon": {
      "post": {
        "tags": [
          "Icons"
        ],
        "summary": "Modify the logo of a tenant to be a specified icon",
        "operationId": "modifyTenantIconBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "description": "The ID of the tenant to change logo for. Example: 'Tenants-1'",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyTenantIconCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Tenant Icon has been modified",
            "schema": {
              "$ref": "#/definitions/ModifyTenantIconResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/logo/icon": {
      "post": {
        "tags": [
          "Icons"
        ],
        "summary": "Modify the logo of a project to be a specified icon",
        "operationId": "modifyProjectIcon",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project to change logo for. Example: 'Projects-1'",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectIconCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Project Icon has been modified",
            "schema": {
              "$ref": "#/definitions/ModifyProjectIconResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tenants/{tenantId}/logo/icon": {
      "post": {
        "tags": [
          "Icons"
        ],
        "summary": "Modify the logo of a tenant to be a specified icon",
        "operationId": "modifyTenantIcon",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "description": "The ID of the tenant to change logo for. Example: 'Tenants-1'",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyTenantIconCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Tenant Icon has been modified",
            "schema": {
              "$ref": "#/definitions/ModifyTenantIconResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/insights/reports/{reportId}/logo": {
      "get": {
        "tags": [
          "Insights"
        ],
        "operationId": "getInsightsReportLogo_LegacyDefaultSpace",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "reportId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/insights/reports": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get a list of Insights Reports",
        "description": "Returns a paginated list of the Insights Reports in the supplied Octopus Deploy Space.",
        "operationId": "getInsightsReportsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/InsightsReportResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Insights"
        ],
        "summary": "Create an Insights Report",
        "description": "Creates a new Insights Report.",
        "operationId": "createInsightsReportBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateInsightsReportCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/InsightsReportResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/insights/reports/v1": {
      "post": {
        "tags": [
          "Insights"
        ],
        "summary": "Create an Insights Report",
        "description": "Creates a new Insights Report.",
        "operationId": "createInsightsReportV1BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateInsightsReportCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/CreateInsightsReportResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/insights/reports/{id}": {
      "get": {
        "tags": [
          "Insights"
        ],
        "operationId": "getInsightsReportByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/InsightsReportResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Insights"
        ],
        "summary": "Update an existing Insights Report",
        "description": "Updates an existing Insights Report",
        "operationId": "modifyInsightsReportBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The Id of the Insights Report",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/InsightsReportResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Insights"
        ],
        "summary": "Delete an Insights Report by ID",
        "description": "Deletes an existing Insights Report.",
        "operationId": "deleteInsightsReportBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Insights Report to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/insights/reports/{id}/v1": {
      "get": {
        "tags": [
          "Insights"
        ],
        "operationId": "getInsightsReportByIdV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetInsightsReportByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Insights"
        ],
        "summary": "Update an existing Insights Report",
        "description": "Updates an existing Insights Report",
        "operationId": "modifyInsightsReportV1BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The Id of the Insights Report",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Insights"
        ],
        "summary": "Delete an Insights Report by ID",
        "description": "Deletes an existing Insights Report.",
        "operationId": "deleteInsightsReportV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Insights Report to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/DeleteInsightsReportResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/insights/reports/{reportId}/deployments": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Request Insights Deployments for a Report",
        "operationId": "getInsightsDeploymentsForReportBySpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "reportId",
            "description": "ID of the Insights Report",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Insights Deployments",
            "schema": {
              "$ref": "#/definitions/GetInsightsDeploymentsForReportResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/insights/reports/{reportId}/deployments/csv": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Request Insights Deployments for a Report",
        "operationId": "getInsightsDeploymentsForReportBySpace",
        "produces": [
          "text/csv",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "reportId",
            "description": "ID of the Insights Report",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/insights/reports/{reportId}/logo": {
      "get": {
        "tags": [
          "Insights"
        ],
        "operationId": "getInsightsReportLogoBySpace",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "reportId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Insights"
        ],
        "summary": "Update the logo associated with the report.",
        "operationId": "modifyInsightsReportLogoBySpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "reportId",
            "description": "The ID of the Insights report.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/insights/reports/{reportId}/logo/icon": {
      "post": {
        "tags": [
          "Insights"
        ],
        "summary": "Modify the logo of an insights report to be a specified icon",
        "operationId": "modifyInsightsReportIconBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "reportId",
            "description": "The ID of the insights report to change logo for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportIconCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Insights Report Icon has been modified",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportIconResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/insights/reports/{reportId}/logo/icon/v1": {
      "post": {
        "tags": [
          "Insights"
        ],
        "summary": "Modify the logo of an insights report to be a specified icon",
        "operationId": "modifyInsightsReportIconV1BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "reportId",
            "description": "The ID of the insights report to change logo for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportIconCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Insights Report Icon has been modified",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportIconResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/insights/reports/{reportId}/metrics": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get Insights metrics series for the Insights Report",
        "description": "Returns the aggregated insights metrics for this insights report for the chosen granularity and time period grouped by the chosen split",
        "operationId": "getInsightsMetricsSeriesForReportBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "reportId",
            "description": "ID of the Insights Report",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "split",
            "description": "How to split the metrics",
            "required": true,
            "type": "string",
            "enum": [
              "None",
              "Project",
              "ProjectGroup",
              "Environment",
              "EnvironmentGroup",
              "Tenant",
              "TenantTagSet"
            ]
          },
          {
            "in": "query",
            "name": "timeRange",
            "description": "The time period to get data for, defaults to last quarter if not supplied",
            "type": "string",
            "enum": [
              "LastMonth",
              "LastQuarter",
              "LastYear"
            ]
          },
          {
            "in": "query",
            "name": "granularity",
            "description": "The data grouping granularity, defaults to weekly if not supplied",
            "type": "string",
            "enum": [
              "Monthly",
              "Weekly",
              "Daily"
            ]
          },
          {
            "in": "query",
            "name": "tenantTagSetId",
            "description": "If TenantTagSet is chosen for Split, this is required, otherwise it is ignored. It is the tag set to split on.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetInsightsMetricsSeriesForReportResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/insights/reports/{reportId}/metrics/v1": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get Insights metrics series for the Insights Report",
        "description": "Returns the aggregated insights metrics for this insights report for the chosen granularity and time period grouped by the chosen split",
        "operationId": "getInsightsMetricsSeriesForReportV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "reportId",
            "description": "ID of the Insights Report",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "split",
            "description": "How to split the metrics",
            "required": true,
            "type": "string",
            "enum": [
              "None",
              "Project",
              "ProjectGroup",
              "Environment",
              "EnvironmentGroup",
              "Tenant",
              "TenantTagSet"
            ]
          },
          {
            "in": "query",
            "name": "timeRange",
            "description": "The time period to get data for, defaults to last quarter if not supplied",
            "type": "string",
            "enum": [
              "LastMonth",
              "LastQuarter",
              "LastYear"
            ]
          },
          {
            "in": "query",
            "name": "granularity",
            "description": "The data grouping granularity, defaults to weekly if not supplied",
            "type": "string",
            "enum": [
              "Monthly",
              "Weekly",
              "Daily"
            ]
          },
          {
            "in": "query",
            "name": "tenantTagSetId",
            "description": "If TenantTagSet is chosen for Split, this is required, otherwise it is ignored. It is the tag set to split on.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetInsightsMetricsSeriesForReportResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/insights/deployments": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get Insights Deployments for a Project",
        "operationId": "getInsightsDeploymentsForProjectBySpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channelId",
            "description": "ID of the Channel",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantFilter",
            "description": "How to filter for tenants, defaults to untenanted and all tenants if not supplied",
            "type": "string",
            "enum": [
              "UntenantedAndAllTenants",
              "Untenanted",
              "SingleTenant"
            ]
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Insights Deployments",
            "schema": {
              "$ref": "#/definitions/GetInsightsDeploymentsForProjectResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/insights/deployments/csv": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get Insights Deployments for a Project",
        "operationId": "getInsightsDeploymentsForProjectBySpace",
        "produces": [
          "text/csv",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channelId",
            "description": "ID of the Channel",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantFilter",
            "description": "How to filter for tenants, defaults to untenanted and all tenants if not supplied",
            "type": "string",
            "enum": [
              "UntenantedAndAllTenants",
              "Untenanted",
              "SingleTenant"
            ]
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/insights/metrics": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get Insights metrics series for the project",
        "description": "Returns the aggregated insights metrics for this project for the chosen granularity and time period",
        "operationId": "getInsightsMetricsSeriesForProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channelId",
            "description": "ID of the Channel",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "granularity",
            "description": "The data grouping granularity, defaults to weekly if not supplied",
            "type": "string",
            "enum": [
              "Monthly",
              "Weekly",
              "Daily"
            ]
          },
          {
            "in": "query",
            "name": "tenantFilter",
            "description": "How to filter for tenants, defaults to untenanted and all tenants (combined) if not supplied",
            "type": "string",
            "enum": [
              "UntenantedAndAllTenants",
              "Untenanted",
              "SingleTenant"
            ]
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "ID of the Tenant",
            "type": "string"
          },
          {
            "in": "query",
            "name": "timeRange",
            "description": "The time period to get data for, defaults to last quarter if not supplied",
            "type": "string",
            "enum": [
              "LastMonth",
              "LastQuarter",
              "LastYear"
            ]
          },
          {
            "in": "query",
            "name": "timeZone",
            "description": "The IANA timezone to use when grouping data, defaults to UTC if not supplied",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetInsightsMetricsSeriesForProjectResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/insights/metrics/v1": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get Insights metrics series for the project",
        "description": "Returns the aggregated insights metrics for this project for the chosen granularity and time period",
        "operationId": "getInsightsMetricsSeriesForProjectV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channelId",
            "description": "ID of the Channel",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "granularity",
            "description": "The data grouping granularity, defaults to weekly if not supplied",
            "type": "string",
            "enum": [
              "Monthly",
              "Weekly",
              "Daily"
            ]
          },
          {
            "in": "query",
            "name": "tenantFilter",
            "description": "How to filter for tenants, defaults to untenanted and all tenants (combined) if not supplied",
            "type": "string",
            "enum": [
              "UntenantedAndAllTenants",
              "Untenanted",
              "SingleTenant"
            ]
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "ID of the Tenant",
            "type": "string"
          },
          {
            "in": "query",
            "name": "timeRange",
            "description": "The time period to get data for, defaults to last quarter if not supplied",
            "type": "string",
            "enum": [
              "LastMonth",
              "LastQuarter",
              "LastYear"
            ]
          },
          {
            "in": "query",
            "name": "timeZone",
            "description": "The IANA timezone to use when grouping data, defaults to UTC if not supplied",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetInsightsMetricsSeriesForProjectResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/insights/reports": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get a list of Insights Reports",
        "description": "Returns a paginated list of the Insights Reports in the supplied Octopus Deploy Space.",
        "operationId": "getInsightsReports",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/InsightsReportResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Insights"
        ],
        "summary": "Create an Insights Report",
        "description": "Creates a new Insights Report.",
        "operationId": "createInsightsReport",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateInsightsReportCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/InsightsReportResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/insights/reports/v1": {
      "post": {
        "tags": [
          "Insights"
        ],
        "summary": "Create an Insights Report",
        "description": "Creates a new Insights Report.",
        "operationId": "createInsightsReportV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateInsightsReportCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/CreateInsightsReportResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/insights/reports/{id}": {
      "get": {
        "tags": [
          "Insights"
        ],
        "operationId": "getInsightsReportById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/InsightsReportResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Insights"
        ],
        "summary": "Update an existing Insights Report",
        "description": "Updates an existing Insights Report",
        "operationId": "modifyInsightsReport",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The Id of the Insights Report",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/InsightsReportResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Insights"
        ],
        "summary": "Delete an Insights Report by ID",
        "description": "Deletes an existing Insights Report.",
        "operationId": "deleteInsightsReport",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Insights Report to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/insights/reports/{id}/v1": {
      "get": {
        "tags": [
          "Insights"
        ],
        "operationId": "getInsightsReportByIdV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetInsightsReportByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Insights"
        ],
        "summary": "Update an existing Insights Report",
        "description": "Updates an existing Insights Report",
        "operationId": "modifyInsightsReportV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The Id of the Insights Report",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Insights"
        ],
        "summary": "Delete an Insights Report by ID",
        "description": "Deletes an existing Insights Report.",
        "operationId": "deleteInsightsReportV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Insights Report to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/DeleteInsightsReportResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/insights/reports/{reportId}/deployments": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Request Insights Deployments for a Report",
        "operationId": "getInsightsDeploymentsForReport_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "reportId",
            "description": "ID of the Insights Report",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Insights Deployments",
            "schema": {
              "$ref": "#/definitions/GetInsightsDeploymentsForReportResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/insights/reports/{reportId}/deployments/csv": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Request Insights Deployments for a Report",
        "operationId": "getInsightsDeploymentsForReport",
        "produces": [
          "text/csv",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "reportId",
            "description": "ID of the Insights Report",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/insights/reports/{reportId}/logo": {
      "get": {
        "tags": [
          "Insights"
        ],
        "operationId": "getInsightsReportLogo",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "reportId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Insights"
        ],
        "summary": "Update the logo associated with the report.",
        "operationId": "modifyInsightsReportLogo",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "reportId",
            "description": "The ID of the Insights report.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/insights/reports/{reportId}/logo/icon": {
      "post": {
        "tags": [
          "Insights"
        ],
        "summary": "Modify the logo of an insights report to be a specified icon",
        "operationId": "modifyInsightsReportIcon",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "reportId",
            "description": "The ID of the insights report to change logo for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportIconCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Insights Report Icon has been modified",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportIconResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/insights/reports/{reportId}/logo/icon/v1": {
      "post": {
        "tags": [
          "Insights"
        ],
        "summary": "Modify the logo of an insights report to be a specified icon",
        "operationId": "modifyInsightsReportIconV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "reportId",
            "description": "The ID of the insights report to change logo for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportIconCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Insights Report Icon has been modified",
            "schema": {
              "$ref": "#/definitions/ModifyInsightsReportIconResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/insights/reports/{reportId}/metrics": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get Insights metrics series for the Insights Report",
        "description": "Returns the aggregated insights metrics for this insights report for the chosen granularity and time period grouped by the chosen split",
        "operationId": "getInsightsMetricsSeriesForReport",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "reportId",
            "description": "ID of the Insights Report",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "split",
            "description": "How to split the metrics",
            "required": true,
            "type": "string",
            "enum": [
              "None",
              "Project",
              "ProjectGroup",
              "Environment",
              "EnvironmentGroup",
              "Tenant",
              "TenantTagSet"
            ]
          },
          {
            "in": "query",
            "name": "timeRange",
            "description": "The time period to get data for, defaults to last quarter if not supplied",
            "type": "string",
            "enum": [
              "LastMonth",
              "LastQuarter",
              "LastYear"
            ]
          },
          {
            "in": "query",
            "name": "granularity",
            "description": "The data grouping granularity, defaults to weekly if not supplied",
            "type": "string",
            "enum": [
              "Monthly",
              "Weekly",
              "Daily"
            ]
          },
          {
            "in": "query",
            "name": "tenantTagSetId",
            "description": "If TenantTagSet is chosen for Split, this is required, otherwise it is ignored. It is the tag set to split on.",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetInsightsMetricsSeriesForReportResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/insights/reports/{reportId}/metrics/v1": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get Insights metrics series for the Insights Report",
        "description": "Returns the aggregated insights metrics for this insights report for the chosen granularity and time period grouped by the chosen split",
        "operationId": "getInsightsMetricsSeriesForReportV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "reportId",
            "description": "ID of the Insights Report",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "split",
            "description": "How to split the metrics",
            "required": true,
            "type": "string",
            "enum": [
              "None",
              "Project",
              "ProjectGroup",
              "Environment",
              "EnvironmentGroup",
              "Tenant",
              "TenantTagSet"
            ]
          },
          {
            "in": "query",
            "name": "timeRange",
            "description": "The time period to get data for, defaults to last quarter if not supplied",
            "type": "string",
            "enum": [
              "LastMonth",
              "LastQuarter",
              "LastYear"
            ]
          },
          {
            "in": "query",
            "name": "granularity",
            "description": "The data grouping granularity, defaults to weekly if not supplied",
            "type": "string",
            "enum": [
              "Monthly",
              "Weekly",
              "Daily"
            ]
          },
          {
            "in": "query",
            "name": "tenantTagSetId",
            "description": "If TenantTagSet is chosen for Split, this is required, otherwise it is ignored. It is the tag set to split on.",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetInsightsMetricsSeriesForReportResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/insights/deployments": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get Insights Deployments for a Project",
        "operationId": "getInsightsDeploymentsForProject_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channelId",
            "description": "ID of the Channel",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantFilter",
            "description": "How to filter for tenants, defaults to untenanted and all tenants if not supplied",
            "type": "string",
            "enum": [
              "UntenantedAndAllTenants",
              "Untenanted",
              "SingleTenant"
            ]
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "ID of the Tenant",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Insights Deployments",
            "schema": {
              "$ref": "#/definitions/GetInsightsDeploymentsForProjectResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/insights/deployments/csv": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get Insights Deployments for a Project",
        "operationId": "getInsightsDeploymentsForProject",
        "produces": [
          "text/csv",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channelId",
            "description": "ID of the Channel",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantFilter",
            "description": "How to filter for tenants, defaults to untenanted and all tenants if not supplied",
            "type": "string",
            "enum": [
              "UntenantedAndAllTenants",
              "Untenanted",
              "SingleTenant"
            ]
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "ID of the Tenant",
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/insights/metrics": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get Insights metrics series for the project",
        "description": "Returns the aggregated insights metrics for this project for the chosen granularity and time period",
        "operationId": "getInsightsMetricsSeriesForProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channelId",
            "description": "ID of the Channel",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "granularity",
            "description": "The data grouping granularity, defaults to weekly if not supplied",
            "type": "string",
            "enum": [
              "Monthly",
              "Weekly",
              "Daily"
            ]
          },
          {
            "in": "query",
            "name": "tenantFilter",
            "description": "How to filter for tenants, defaults to untenanted and all tenants (combined) if not supplied",
            "type": "string",
            "enum": [
              "UntenantedAndAllTenants",
              "Untenanted",
              "SingleTenant"
            ]
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "ID of the Tenant",
            "type": "string"
          },
          {
            "in": "query",
            "name": "timeRange",
            "description": "The time period to get data for, defaults to last quarter if not supplied",
            "type": "string",
            "enum": [
              "LastMonth",
              "LastQuarter",
              "LastYear"
            ]
          },
          {
            "in": "query",
            "name": "timeZone",
            "description": "The IANA timezone to use when grouping data, defaults to UTC if not supplied",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetInsightsMetricsSeriesForProjectResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/insights/metrics/v1": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Get Insights metrics series for the project",
        "description": "Returns the aggregated insights metrics for this project for the chosen granularity and time period",
        "operationId": "getInsightsMetricsSeriesForProjectV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "channelId",
            "description": "ID of the Channel",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "granularity",
            "description": "The data grouping granularity, defaults to weekly if not supplied",
            "type": "string",
            "enum": [
              "Monthly",
              "Weekly",
              "Daily"
            ]
          },
          {
            "in": "query",
            "name": "tenantFilter",
            "description": "How to filter for tenants, defaults to untenanted and all tenants (combined) if not supplied",
            "type": "string",
            "enum": [
              "UntenantedAndAllTenants",
              "Untenanted",
              "SingleTenant"
            ]
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "ID of the Tenant",
            "type": "string"
          },
          {
            "in": "query",
            "name": "timeRange",
            "description": "The time period to get data for, defaults to last quarter if not supplied",
            "type": "string",
            "enum": [
              "LastMonth",
              "LastQuarter",
              "LastYear"
            ]
          },
          {
            "in": "query",
            "name": "timeZone",
            "description": "The IANA timezone to use when grouping data, defaults to UTC if not supplied",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GetInsightsMetricsSeriesForProjectResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/integrated-challenge": {
      "get": {
        "tags": [
          "IntegratedAuthentication"
        ],
        "operationId": "IntegratedChallenge",
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/interruptions": {
      "get": {
        "tags": [
          "Interruptions"
        ],
        "summary": "List interruptions for user attention. The results will be sorted by date from most recently to least recently created.",
        "operationId": "listInterruptions_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "List of specific interruption IDs to load",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "pendingOnly",
            "description": "If true, lists only pending interruptions",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "regarding",
            "description": "Lists interruptions related to a specific other document, specified by its ID (e.g. a ServerTasks-*, Projects-* or Environments-* ID).",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a list of interruptions returned in response to ListInterruptionsRequest",
            "schema": {
              "$ref": "#/definitions/InterruptionResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/interruptions/{id}": {
      "get": {
        "tags": [
          "Interruptions"
        ],
        "summary": "Get an Interruption by ID",
        "operationId": "getInterruptionById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Interruption to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Interruption",
            "schema": {
              "$ref": "#/definitions/InterruptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/interruptions/{id}/responsible": {
      "get": {
        "tags": [
          "Interruptions"
        ],
        "summary": "Get the User that is currently responsible for this Interruption (if any).",
        "operationId": "getInterruptionResponsibleUser_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Interruption",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Interruptions"
        ],
        "summary": "Allow the current user to take responsibility for this interruption. Only users in one of the responsible teams on this interruption can take responsibility for it.",
        "operationId": "takeResponsibilityForInterruption_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Interruption",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The User responsible for the requested Interruption",
            "schema": {
              "$ref": "#/definitions/UserResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/interruptions/{id}/submit": {
      "post": {
        "tags": [
          "Interruptions"
        ],
        "summary": "Submit a dictionary of form values for the interruption. Only the user with responsibility for this interruption can submit this form.",
        "operationId": "submitInterruption_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Interruption",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/SubmitInterruptionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that the Interruption has been submitted successfully, containing the updated Interruption",
            "schema": {
              "$ref": "#/definitions/InterruptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/interruptions": {
      "get": {
        "tags": [
          "Interruptions"
        ],
        "summary": "List interruptions for user attention. The results will be sorted by date from most recently to least recently created.",
        "operationId": "listInterruptionsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of specific interruption IDs to load",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "pendingOnly",
            "description": "If true, lists only pending interruptions",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "regarding",
            "description": "Lists interruptions related to a specific other document, specified by its ID (e.g. a ServerTasks-*, Projects-* or Environments-* ID).",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a list of interruptions returned in response to ListInterruptionsRequest",
            "schema": {
              "$ref": "#/definitions/InterruptionResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/interruptions/{id}": {
      "get": {
        "tags": [
          "Interruptions"
        ],
        "summary": "Get an Interruption by ID",
        "operationId": "getInterruptionByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Interruption to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Interruption",
            "schema": {
              "$ref": "#/definitions/InterruptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/interruptions/{id}/responsible": {
      "get": {
        "tags": [
          "Interruptions"
        ],
        "summary": "Get the User that is currently responsible for this Interruption (if any).",
        "operationId": "getInterruptionResponsibleUserBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Interruption",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Interruptions"
        ],
        "summary": "Allow the current user to take responsibility for this interruption. Only users in one of the responsible teams on this interruption can take responsibility for it.",
        "operationId": "takeResponsibilityForInterruptionBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Interruption",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The User responsible for the requested Interruption",
            "schema": {
              "$ref": "#/definitions/UserResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/interruptions/{id}/submit": {
      "post": {
        "tags": [
          "Interruptions"
        ],
        "summary": "Submit a dictionary of form values for the interruption. Only the user with responsibility for this interruption can submit this form.",
        "operationId": "submitInterruptionBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Interruption",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/SubmitInterruptionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that the Interruption has been submitted successfully, containing the updated Interruption",
            "schema": {
              "$ref": "#/definitions/InterruptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/interruptions": {
      "get": {
        "tags": [
          "Interruptions"
        ],
        "summary": "List interruptions for user attention. The results will be sorted by date from most recently to least recently created.",
        "operationId": "listInterruptions",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of specific interruption IDs to load",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "pendingOnly",
            "description": "If true, lists only pending interruptions",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "regarding",
            "description": "Lists interruptions related to a specific other document, specified by its ID (e.g. a ServerTasks-*, Projects-* or Environments-* ID).",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a list of interruptions returned in response to ListInterruptionsRequest",
            "schema": {
              "$ref": "#/definitions/InterruptionResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/interruptions/{id}": {
      "get": {
        "tags": [
          "Interruptions"
        ],
        "summary": "Get an Interruption by ID",
        "operationId": "getInterruptionById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Interruption to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Interruption",
            "schema": {
              "$ref": "#/definitions/InterruptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/interruptions/{id}/responsible": {
      "get": {
        "tags": [
          "Interruptions"
        ],
        "summary": "Get the User that is currently responsible for this Interruption (if any).",
        "operationId": "getInterruptionResponsibleUser",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Interruption",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Interruptions"
        ],
        "summary": "Allow the current user to take responsibility for this interruption. Only users in one of the responsible teams on this interruption can take responsibility for it.",
        "operationId": "takeResponsibilityForInterruption",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Interruption",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The User responsible for the requested Interruption",
            "schema": {
              "$ref": "#/definitions/UserResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/interruptions/{id}/submit": {
      "post": {
        "tags": [
          "Interruptions"
        ],
        "summary": "Submit a dictionary of form values for the interruption. Only the user with responsibility for this interruption can submit this form.",
        "operationId": "submitInterruption",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Interruption",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/SubmitInterruptionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that the Interruption has been submitted successfully, containing the updated Interruption",
            "schema": {
              "$ref": "#/definitions/InterruptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/invitations": {
      "post": {
        "tags": [
          "Invitations"
        ],
        "summary": "Create an invitation to allow a new person to join this Octopus instance",
        "operationId": "createInvitation_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateInvitationCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/InvitationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/invitations/{id}": {
      "get": {
        "tags": [
          "Invitations"
        ],
        "summary": "Get an Invitation by ID.",
        "operationId": "getInvitationById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Invitation to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "An Invitation object",
            "schema": {
              "$ref": "#/definitions/InvitationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/users/invitations": {
      "post": {
        "tags": [
          "Invitations"
        ],
        "summary": "Create an invitation to allow a new person to join this Octopus instance",
        "operationId": "createInvitationBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space to create the invitation in.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateInvitationCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/InvitationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/users/invitations/{id}": {
      "get": {
        "tags": [
          "Invitations"
        ],
        "summary": "Get an Invitation by ID.",
        "operationId": "getInvitationByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resources.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Invitation to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "An Invitation object",
            "schema": {
              "$ref": "#/definitions/InvitationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/users/invitations": {
      "post": {
        "tags": [
          "Invitations"
        ],
        "summary": "Create an invitation to allow a new person to join this Octopus instance",
        "operationId": "createInvitation",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateInvitationCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/InvitationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/users/invitations/{id}": {
      "get": {
        "tags": [
          "Invitations"
        ],
        "summary": "Get an Invitation by ID.",
        "operationId": "getInvitationById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Invitation to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "An Invitation object",
            "schema": {
              "$ref": "#/definitions/InvitationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/jiraintegration/connectivitycheck/connectapp": {
      "post": {
        "tags": [
          "JiraIntegration"
        ],
        "operationId": "postJiraConnectAppConnectivityCheck",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/jiraintegration/connectivitycheck/jira": {
      "post": {
        "tags": [
          "JiraIntegration"
        ],
        "operationId": "postJiraCredentialsConnectivityCheck",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/.well-known/jwks": {
      "get": {
        "tags": [
          "JsonWebKeys"
        ],
        "summary": "Get signing keys used by Octopus Server in JWK format",
        "operationId": "getJsonWebKeys",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Rseponse to getting set of JsonWebKeys",
            "schema": {
              "$ref": "#/definitions/GetJsonWebKeysResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/externalgroups/ldap": {
      "get": {
        "tags": [
          "LDAP"
        ],
        "summary": "Search for LDAP groups",
        "description": "Search for LDAP groups",
        "operationId": "getListSecurityGroups_Legacy0",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/externalusers/ldap": {
      "get": {
        "tags": [
          "LDAP"
        ],
        "summary": "Search for LDAP users",
        "description": "Search for LDAP users",
        "operationId": "getUserLookup_Legacy0",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/letsencryptconfiguration": {
      "get": {
        "tags": [
          "LetsEncrypt"
        ],
        "summary": "Request the current Let's Encrypt configuration",
        "operationId": "getLetsEncryptConfiguration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The current Let's Encrypt configuration for this Octopus Server",
            "schema": {
              "$ref": "#/definitions/LetsEncryptConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "LetsEncrypt"
        ],
        "summary": "Allow you to disable the Let's Encrypt configuration for this Octopus Server",
        "operationId": "modifyLetsEncryptConfiguration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyLetsEncryptConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The updated configuration",
            "schema": {
              "$ref": "#/definitions/LetsEncryptConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/libraryvariablesets": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "List all of the library variable sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getLibraryVariableSets_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "contentType",
            "description": "Filters by the purpose of the set: 'Variables' for ordinary variable sets or 'ScriptModule' for script modules. Omit to return both.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Library Variable Set to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "All of the library variable sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
            "schema": {
              "$ref": "#/definitions/LibraryVariableSetResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Create a new library variable set.",
        "operationId": "createLibraryVariableSets_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateLibraryVariableSetsCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/LibraryVariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/libraryvariablesets/all": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Get a list of Library Variable Sets",
        "description": "Lists all the Library Variable Sets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllLibraryVariableSets_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "contentType",
            "description": "A content type use to filter Library Variable Sets.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Library Variable Set ids used to filter.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Library Variable Sets",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/LibraryVariableSetResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/libraryvariablesets/all/v1": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Get a list of Library Variable Sets",
        "description": "Lists all the Library Variable Sets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllLibraryVariableSetsV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "contentType",
            "description": "A content type use to filter Library Variable Sets.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Library Variable Set ids used to filter.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Library Variable Sets",
            "schema": {
              "$ref": "#/definitions/GetAllLibraryVariableSetsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Get a list of Library Variable Sets",
        "description": "Lists all the Library Variable Sets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllLibraryVariableSetsV1UsingPost_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "contentType",
            "description": "A content type use to filter Library Variable Sets.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Library Variable Set ids used to filter.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Library Variable Sets",
            "schema": {
              "$ref": "#/definitions/GetAllLibraryVariableSetsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/libraryvariablesets/{id}": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Get a Library Variable Set by ID.",
        "operationId": "getLibraryVariableSetById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Library Variable Set to load.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The Library Variable Set with matching ID.",
            "schema": {
              "$ref": "#/definitions/LibraryVariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Modify an existing library variable set.",
        "operationId": "modifyLibraryVariableSet_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the library variable set.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyLibraryVariableSetCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified library variable set.",
            "schema": {
              "$ref": "#/definitions/LibraryVariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Delete an existing Library Variable Set.",
        "operationId": "deleteLibraryVariableSet_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Library Variable Set to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/libraryvariablesets/{id}/usages": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "List projects and deployments which are using an library variable set.",
        "operationId": "getLibraryVariableSetUsage_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Library Variable Set.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The usages of the library variable set.",
            "schema": {
              "$ref": "#/definitions/GetLibraryVariableSetUsageResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/libraryvariablesets": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "List all of the library variable sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getLibraryVariableSetsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "contentType",
            "description": "Filters by the purpose of the set: 'Variables' for ordinary variable sets or 'ScriptModule' for script modules. Omit to return both.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Library Variable Set to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "All of the library variable sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
            "schema": {
              "$ref": "#/definitions/LibraryVariableSetResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Create a new library variable set.",
        "operationId": "createLibraryVariableSetsBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateLibraryVariableSetsCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/LibraryVariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/libraryvariablesets/all": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Get a list of Library Variable Sets",
        "description": "Lists all the Library Variable Sets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllLibraryVariableSetsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "contentType",
            "description": "A content type use to filter Library Variable Sets.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Library Variable Set ids used to filter.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Library Variable Sets",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/LibraryVariableSetResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/libraryvariablesets/all/v1": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Get a list of Library Variable Sets",
        "description": "Lists all the Library Variable Sets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllLibraryVariableSetsV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "contentType",
            "description": "A content type use to filter Library Variable Sets.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Library Variable Set ids used to filter.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Library Variable Sets",
            "schema": {
              "$ref": "#/definitions/GetAllLibraryVariableSetsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Get a list of Library Variable Sets",
        "description": "Lists all the Library Variable Sets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllLibraryVariableSetsV1BySpaceUsingPost",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "contentType",
            "description": "A content type use to filter Library Variable Sets.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Library Variable Set ids used to filter.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Library Variable Sets",
            "schema": {
              "$ref": "#/definitions/GetAllLibraryVariableSetsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/libraryvariablesets/{id}": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Get a Library Variable Set by ID.",
        "operationId": "getLibraryVariableSetByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Library Variable Set to load.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The Library Variable Set with matching ID.",
            "schema": {
              "$ref": "#/definitions/LibraryVariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Modify an existing library variable set.",
        "operationId": "modifyLibraryVariableSetBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the library variable set.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyLibraryVariableSetCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified library variable set.",
            "schema": {
              "$ref": "#/definitions/LibraryVariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Delete an existing Library Variable Set.",
        "operationId": "deleteLibraryVariableSetBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Library Variable Set to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/libraryvariablesets/{id}/usages": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "List projects and deployments which are using an library variable set.",
        "operationId": "getLibraryVariableSetUsageBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Library Variable Set.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The usages of the library variable set.",
            "schema": {
              "$ref": "#/definitions/GetLibraryVariableSetUsageResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/libraryvariablesets": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "List all of the library variable sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getLibraryVariableSets",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "contentType",
            "description": "Filters by the purpose of the set: 'Variables' for ordinary variable sets or 'ScriptModule' for script modules. Omit to return both.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Library Variable Set to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "All of the library variable sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
            "schema": {
              "$ref": "#/definitions/LibraryVariableSetResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Create a new library variable set.",
        "operationId": "createLibraryVariableSets",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateLibraryVariableSetsCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/LibraryVariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/libraryvariablesets/all": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Get a list of Library Variable Sets",
        "description": "Lists all the Library Variable Sets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllLibraryVariableSets",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "contentType",
            "description": "A content type use to filter Library Variable Sets.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Library Variable Set ids used to filter.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Library Variable Sets",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/LibraryVariableSetResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/libraryvariablesets/all/v1": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Get a list of Library Variable Sets",
        "description": "Lists all the Library Variable Sets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllLibraryVariableSetsV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "contentType",
            "description": "A content type use to filter Library Variable Sets.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Library Variable Set ids used to filter.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Library Variable Sets",
            "schema": {
              "$ref": "#/definitions/GetAllLibraryVariableSetsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Get a list of Library Variable Sets",
        "description": "Lists all the Library Variable Sets in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllLibraryVariableSetsV1UsingPost",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "contentType",
            "description": "A content type use to filter Library Variable Sets.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Library Variable Set ids used to filter.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Library Variable Sets",
            "schema": {
              "$ref": "#/definitions/GetAllLibraryVariableSetsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/libraryvariablesets/{id}": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Get a Library Variable Set by ID.",
        "operationId": "getLibraryVariableSetById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Library Variable Set to load.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The Library Variable Set with matching ID.",
            "schema": {
              "$ref": "#/definitions/LibraryVariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Modify an existing library variable set.",
        "operationId": "modifyLibraryVariableSet",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the library variable set.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyLibraryVariableSetCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified library variable set.",
            "schema": {
              "$ref": "#/definitions/LibraryVariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "Delete an existing Library Variable Set.",
        "operationId": "deleteLibraryVariableSet",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Library Variable Set to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/libraryvariablesets/{id}/usages": {
      "get": {
        "tags": [
          "LibraryVariableSets"
        ],
        "summary": "List projects and deployments which are using an library variable set.",
        "operationId": "getLibraryVariableSetUsage",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Library Variable Set.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The usages of the library variable set.",
            "schema": {
              "$ref": "#/definitions/GetLibraryVariableSetUsageResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/licenses/licenses-current": {
      "get": {
        "tags": [
          "Licenses"
        ],
        "summary": "Return the details of the current license in use by the Octopus Cluster.",
        "operationId": "getCurrentLicense",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested License",
            "schema": {
              "$ref": "#/definitions/LicenseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Licenses"
        ],
        "summary": "Update the current Octopus cluster license.",
        "description": "Updates the license for the Octopus cluster.",
        "operationId": "modifyCurrentLicense",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyCurrentLicenseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Current License has been modified, containing the new License",
            "schema": {
              "$ref": "#/definitions/LicenseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/licenses/licenses-current-features": {
      "get": {
        "tags": [
          "Licenses"
        ],
        "summary": "Return a list of enabled features from the license",
        "operationId": "getCurrentLicenseFeatures",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The list of enabled features from the license",
            "schema": {
              "$ref": "#/definitions/GetCurrentLicenseFeaturesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/licenses/licenses-current-status": {
      "get": {
        "tags": [
          "Licenses"
        ],
        "summary": "Get the status of the current Octopus license.",
        "description": "Calculates the status of the current Octopus license including compliance and maintenance expiry.",
        "operationId": "getCurrentLicenseStatus",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested License Status",
            "schema": {
              "$ref": "#/definitions/LicenseStatusResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/licenses/licenses-current-usage": {
      "get": {
        "tags": [
          "Licenses"
        ],
        "summary": "Get the usage of the current Octopus server.",
        "description": "Calculates the usage of the current Octopus server.",
        "operationId": "getCurrentLicenseUsage",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/LicenseUsageResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/lifecycles": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "List the Lifecycles in the supplied Octopus Deploy Space in pages. The results will be sorted alphabetically by name.",
        "operationId": "getLifecycles_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Lifecycle to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of lifecycles",
            "schema": {
              "$ref": "#/definitions/LifecycleResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Create a new Lifecycle.",
        "operationId": "createLifecycle_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateLifecycleCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/LifecycleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/lifecycles/all": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "List all the lifecycles in the supplied Octopus Deploy Space.",
        "operationId": "getAllLifecycles_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "All of the lifecycles in the supplied Octopus Deploy Space.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/LifecycleResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/lifecycles/previews": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Get a list of Lifecycle previews",
        "operationId": "getLifecyclePreviews_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "The IDs of the Lifecycles to retrieve",
            "required": true,
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Get a list of Lifecycle previews",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/LifecycleResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/lifecycles/{id}": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Get a specific Lifecycle",
        "description": "This request does not support getting Lifecycles that belong to Templated Projects",
        "operationId": "getLifecycleById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Lifecycle",
            "schema": {
              "$ref": "#/definitions/LifecycleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Modify a Lifecycle.",
        "operationId": "modifyLifecycle_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The Id of the Lifecycle to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyLifecycleCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a Lifecycle resource which represents changes to the Lifecycle.",
            "schema": {
              "$ref": "#/definitions/LifecycleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Delete an existing Lifecycle",
        "operationId": "deleteLifecycle_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the lifecycle to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/DeleteLifecycleResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/lifecycles/{id}/preview": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Get a Lifecycle preview by Lifecycle id.",
        "operationId": "getLifecyclePreview_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Lifecycle.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a Lifecycle preview",
            "schema": {
              "$ref": "#/definitions/LifecycleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/lifecycles/{id}/projects": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Get all projects that use this lifecycle.",
        "operationId": "getProjectsByLifecycle_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Lifecycle.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Get all projects that use this lifecycle.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/lifecycles": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "List the Lifecycles in the supplied Octopus Deploy Space in pages. The results will be sorted alphabetically by name.",
        "operationId": "getLifecyclesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Lifecycle to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of lifecycles",
            "schema": {
              "$ref": "#/definitions/LifecycleResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Create a new Lifecycle.",
        "operationId": "createLifecycleBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the Space for the Lifecycle.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateLifecycleCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/LifecycleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/lifecycles/all": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "List all the lifecycles in the supplied Octopus Deploy Space.",
        "operationId": "getAllLifecyclesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "All of the lifecycles in the supplied Octopus Deploy Space.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/LifecycleResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/lifecycles/previews": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Get a list of Lifecycle previews",
        "operationId": "getLifecyclePreviewsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The Space ID of the Lifecycles",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "The IDs of the Lifecycles to retrieve",
            "required": true,
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Get a list of Lifecycle previews",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/LifecycleResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/lifecycles/{id}": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Get a specific Lifecycle",
        "description": "This request does not support getting Lifecycles that belong to Templated Projects",
        "operationId": "getLifecycleByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Lifecycle",
            "schema": {
              "$ref": "#/definitions/LifecycleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Modify a Lifecycle.",
        "operationId": "modifyLifecycleBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the Space for the Lifecycle.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The Id of the Lifecycle to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyLifecycleCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a Lifecycle resource which represents changes to the Lifecycle.",
            "schema": {
              "$ref": "#/definitions/LifecycleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Delete an existing Lifecycle",
        "operationId": "deleteLifecycleBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the lifecycle to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/DeleteLifecycleResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/lifecycles/{id}/preview": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Get a Lifecycle preview by Lifecycle id.",
        "operationId": "getLifecyclePreviewBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the Lifecycle.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Lifecycle.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a Lifecycle preview",
            "schema": {
              "$ref": "#/definitions/LifecycleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/lifecycles/{id}/projects": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Get all projects that use this lifecycle.",
        "operationId": "getProjectsByLifecycleBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the Lifecycle and projects.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Lifecycle.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Get all projects that use this lifecycle.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/lifecycles": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "List the Lifecycles in the supplied Octopus Deploy Space in pages. The results will be sorted alphabetically by name.",
        "operationId": "getLifecycles",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Lifecycle to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of lifecycles",
            "schema": {
              "$ref": "#/definitions/LifecycleResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Create a new Lifecycle.",
        "operationId": "createLifecycle",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateLifecycleCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/LifecycleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/lifecycles/all": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "List all the lifecycles in the supplied Octopus Deploy Space.",
        "operationId": "getAllLifecycles",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "All of the lifecycles in the supplied Octopus Deploy Space.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/LifecycleResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/lifecycles/previews": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Get a list of Lifecycle previews",
        "operationId": "getLifecyclePreviews",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "The IDs of the Lifecycles to retrieve",
            "required": true,
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Get a list of Lifecycle previews",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/LifecycleResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/lifecycles/{id}": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Get a specific Lifecycle",
        "description": "This request does not support getting Lifecycles that belong to Templated Projects",
        "operationId": "getLifecycleById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Lifecycle",
            "schema": {
              "$ref": "#/definitions/LifecycleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Modify a Lifecycle.",
        "operationId": "modifyLifecycle",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The Id of the Lifecycle to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyLifecycleCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a Lifecycle resource which represents changes to the Lifecycle.",
            "schema": {
              "$ref": "#/definitions/LifecycleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Delete an existing Lifecycle",
        "operationId": "deleteLifecycle",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the lifecycle to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/DeleteLifecycleResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/lifecycles/{id}/preview": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Get a Lifecycle preview by Lifecycle id.",
        "operationId": "getLifecyclePreview",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Lifecycle.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a Lifecycle preview",
            "schema": {
              "$ref": "#/definitions/LifecycleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/lifecycles/{id}/projects": {
      "get": {
        "tags": [
          "Lifecycles"
        ],
        "summary": "Get all projects that use this lifecycle.",
        "operationId": "getProjectsByLifecycle",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Lifecycle.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Get all projects that use this lifecycle.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machinepolicies": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a paginated list of the Machine Policies in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getMachinePolicies_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "Specific machine policy IDs to filter out",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial machine policy name used for a sub-string search.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the Machine Policies in the supplied Octopus Deploy Space (sorted alphabetically by name).",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Create a new Machine Policy",
        "operationId": "createMachinePolicy_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateMachinePolicyCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machinepolicies/all": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a list of Machine Policies",
        "operationId": "getAllMachinePolicies_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "All the Machine Policies in the supplied Octopus Deploy Space.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/MachinePolicyResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machinepolicies/template": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a template for a new Machine Policy, which includes any defaults.",
        "operationId": "getMachinePolicyTemplate_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested Machine Policy Template",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machinepolicies/{id}": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a Machine Policy by ID",
        "operationId": "getMachinePolicyById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Machine Policy",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested machine policy",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Modify an existing Machine Policy",
        "operationId": "modifyMachinePolicy_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The Machine Policy ID",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyMachinePolicyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Machine Policy was modified, containing the new Policy",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Delete the specified Machine Policy",
        "operationId": "deleteMachinePolicy_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Machine Policy to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machinepolicies/{id}/machines": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a paginated list of the machines that belong to the given Machine Policy",
        "operationId": "getMachinePolicyMachines_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Machine Policy",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the machines that belong to the given Machine Policy",
            "schema": {
              "$ref": "#/definitions/MachineResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machinepolicies/{id}/v1": {
      "delete": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Delete the specified Machine Policy",
        "operationId": "deleteMachinePolicyV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Machine Policy to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Machine Policy has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteMachinePolicyResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machinepolicies/{id}/workers": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a paginated list of the workers that belong to the given Machine Policy",
        "operationId": "getMachinePolicyWorkers_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Machine Policy",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the machines that belong to the given Machine Policy",
            "schema": {
              "$ref": "#/definitions/WorkerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machinepolicies": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a paginated list of the Machine Policies in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getMachinePoliciesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Specific machine policy IDs to filter out",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial machine policy name used for a sub-string search.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the Machine Policies in the supplied Octopus Deploy Space (sorted alphabetically by name).",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Create a new Machine Policy",
        "operationId": "createMachinePolicyBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateMachinePolicyCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machinepolicies/all": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a list of Machine Policies",
        "operationId": "getAllMachinePoliciesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "All the Machine Policies in the supplied Octopus Deploy Space.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/MachinePolicyResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machinepolicies/template": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a template for a new Machine Policy, which includes any defaults.",
        "operationId": "getMachinePolicyTemplateBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Machine Policy Template",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machinepolicies/{id}": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a Machine Policy by ID",
        "operationId": "getMachinePolicyByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Machine Policy",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested machine policy",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Modify an existing Machine Policy",
        "operationId": "modifyMachinePolicyBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The Space ID",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The Machine Policy ID",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyMachinePolicyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Machine Policy was modified, containing the new Policy",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Delete the specified Machine Policy",
        "operationId": "deleteMachinePolicyBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Machine Policy to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machinepolicies/{id}/machines": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a paginated list of the machines that belong to the given Machine Policy",
        "operationId": "getMachinePolicyMachinesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Machine Policy",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the machines that belong to the given Machine Policy",
            "schema": {
              "$ref": "#/definitions/MachineResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machinepolicies/{id}/v1": {
      "delete": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Delete the specified Machine Policy",
        "operationId": "deleteMachinePolicyV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Machine Policy to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Machine Policy has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteMachinePolicyResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machinepolicies/{id}/workers": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a paginated list of the workers that belong to the given Machine Policy",
        "operationId": "getMachinePolicyWorkersBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Machine Policy",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the machines that belong to the given Machine Policy",
            "schema": {
              "$ref": "#/definitions/WorkerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machinepolicies": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a paginated list of the Machine Policies in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getMachinePolicies",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Specific machine policy IDs to filter out",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial machine policy name used for a sub-string search.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the Machine Policies in the supplied Octopus Deploy Space (sorted alphabetically by name).",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Create a new Machine Policy",
        "operationId": "createMachinePolicy",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateMachinePolicyCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machinepolicies/all": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a list of Machine Policies",
        "operationId": "getAllMachinePolicies",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "All the Machine Policies in the supplied Octopus Deploy Space.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/MachinePolicyResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machinepolicies/template": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a template for a new Machine Policy, which includes any defaults.",
        "operationId": "getMachinePolicyTemplate",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Machine Policy Template",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machinepolicies/{id}": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a Machine Policy by ID",
        "operationId": "getMachinePolicyById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Machine Policy",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested machine policy",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Modify an existing Machine Policy",
        "operationId": "modifyMachinePolicy",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The Machine Policy ID",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyMachinePolicyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Machine Policy was modified, containing the new Policy",
            "schema": {
              "$ref": "#/definitions/MachinePolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Delete the specified Machine Policy",
        "operationId": "deleteMachinePolicy",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Machine Policy to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machinepolicies/{id}/machines": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a paginated list of the machines that belong to the given Machine Policy",
        "operationId": "getMachinePolicyMachines",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Machine Policy",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the machines that belong to the given Machine Policy",
            "schema": {
              "$ref": "#/definitions/MachineResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machinepolicies/{id}/v1": {
      "delete": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Delete the specified Machine Policy",
        "operationId": "deleteMachinePolicyV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Machine Policy to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Machine Policy has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteMachinePolicyResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machinepolicies/{id}/workers": {
      "get": {
        "tags": [
          "MachinePolicies"
        ],
        "summary": "Get a paginated list of the workers that belong to the given Machine Policy",
        "operationId": "getMachinePolicyWorkers",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Machine Policy",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the machines that belong to the given Machine Policy",
            "schema": {
              "$ref": "#/definitions/WorkerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machineroles/all": {
      "get": {
        "tags": [
          "MachineRoles"
        ],
        "summary": "Get all machine roles that have been defined in this Octopus installation.",
        "operationId": "getAllMachineRoles_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested list of Machine Roles",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machineroles/all/v1": {
      "get": {
        "tags": [
          "MachineRoles"
        ],
        "summary": "Get all machine roles that have been defined in this Octopus installation.",
        "operationId": "getAllMachineRolesV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested list of Machine Roles",
            "schema": {
              "$ref": "#/definitions/GetAllMachineRolesResponse"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machineroles/all": {
      "get": {
        "tags": [
          "MachineRoles"
        ],
        "summary": "Get all machine roles that have been defined in this Octopus installation.",
        "operationId": "getAllMachineRolesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Machine Roles",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machineroles/all/v1": {
      "get": {
        "tags": [
          "MachineRoles"
        ],
        "summary": "Get all machine roles that have been defined in this Octopus installation.",
        "operationId": "getAllMachineRolesV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Machine Roles",
            "schema": {
              "$ref": "#/definitions/GetAllMachineRolesResponse"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machineroles/all": {
      "get": {
        "tags": [
          "MachineRoles"
        ],
        "summary": "Get all machine roles that have been defined in this Octopus installation.",
        "operationId": "getAllMachineRoles",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Machine Roles",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machineroles/all/v1": {
      "get": {
        "tags": [
          "MachineRoles"
        ],
        "summary": "Get all machine roles that have been defined in this Octopus installation.",
        "operationId": "getAllMachineRolesV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Machine Roles",
            "schema": {
              "$ref": "#/definitions/GetAllMachineRolesResponse"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/machines/{id}/connection": {
      "get": {
        "tags": [
          "Machines"
        ],
        "summary": "Get the status of the network connection between the Octopus server and a machine.",
        "operationId": "getMachineConnection_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the machine whose connection status is being requested.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The connection status",
            "schema": {
              "$ref": "#/definitions/MachineConnectionStatus"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/machines/{id}/connection": {
      "get": {
        "tags": [
          "Machines"
        ],
        "summary": "Get the status of the network connection between the Octopus server and a machine.",
        "operationId": "getMachineConnectionBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the space.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the machine whose connection status is being requested.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The connection status",
            "schema": {
              "$ref": "#/definitions/MachineConnectionStatus"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/machines/{id}/connection": {
      "get": {
        "tags": [
          "Machines"
        ],
        "summary": "Get the status of the network connection between the Octopus server and a machine.",
        "operationId": "getMachineConnection",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the machine whose connection status is being requested.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The connection status",
            "schema": {
              "$ref": "#/definitions/MachineConnectionStatus"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/maintenanceconfiguration": {
      "get": {
        "tags": [
          "MaintenanceConfiguration"
        ],
        "summary": "Get information about the maintenance configuration in use by the Octopus Server.",
        "operationId": "getMaintenanceConfiguration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested Maintenance Configuration",
            "schema": {
              "$ref": "#/definitions/MaintenanceConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "MaintenanceConfiguration"
        ],
        "summary": "Update the maintenance configuration used by the Octopus Server.",
        "operationId": "modifyMaintenanceConfiguration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyMaintenanceConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Maintenance Configuration has been modified, containing the updated configuration",
            "schema": {
              "$ref": "#/definitions/MaintenanceConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/maintenanceconfiguration/v1": {
      "put": {
        "tags": [
          "MaintenanceConfiguration"
        ],
        "summary": "Update the maintenance configuration used by the Octopus Server.",
        "operationId": "modifyMaintenanceConfigurationV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyMaintenanceConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Maintenance Configuration has been modified, containing the updated configuration",
            "schema": {
              "$ref": "#/definitions/ModifyMaintenanceConfigurationResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/migrations/import": {
      "post": {
        "tags": [
          "Migrations"
        ],
        "summary": "Import API",
        "description": "The import API lets you import a migration package from your Octopus Server's built-in package feed (which is where packages are pushed to when using the partial-export API).",
        "operationId": "createMigrationImportTask",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateMigrationImportTaskCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested import task that has been queued.",
            "schema": {
              "$ref": "#/definitions/MigrationImportResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/migrations/partialexport": {
      "post": {
        "tags": [
          "Migrations"
        ],
        "summary": "Partial export API",
        "description": "Using the partial-export API, we can export one or more of our projects and choose to send the package to the destination Octopus Server's package feed.",
        "operationId": "createMigrationPartialExportTask",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateMigrationPartialExportTaskCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested partial export task that has been queued.",
            "schema": {
              "$ref": "#/definitions/MigrationPartialExportResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/nuget/packages": {
      "put": {
        "tags": [
          "Nuget"
        ],
        "summary": "Push packages to this endpoint using NuGet.exe or compatible tools.",
        "operationId": "uploadNugetPackage",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "201": {
            "description": "Created PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/nuget/packages": {
      "put": {
        "tags": [
          "Nuget"
        ],
        "summary": "Push packages to this endpoint using NuGet.exe or compatible tools.",
        "operationId": "uploadNugetPackageBySpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "201": {
            "description": "Created PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/observability/agents": {
      "post": {
        "tags": [
          "Observability"
        ],
        "summary": "Register and trusts new Kubernetes Monitor.",
        "operationId": "registerKubernetesMonitorBySpace_Legacy0",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RegisterKubernetesMonitorCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing the registered agent.",
            "schema": {
              "$ref": "#/definitions/RegisterKubernetesMonitorResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/observability/events/sessions": {
      "post": {
        "tags": [
          "Observability"
        ],
        "summary": "Request the Kubernetes monitor to start sending events for the specified resource",
        "operationId": "beginResourceEventsSessionBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BeginResourceEventsSessionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation response containing a session ID for the event session",
            "schema": {
              "$ref": "#/definitions/BeginResourceEventsSessionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/observability/events/sessions/{sessionId}": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request to fetch all the events for the specified session",
        "operationId": "getResourceEventsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing the events for a sessionID",
            "schema": {
              "$ref": "#/definitions/GetResourceEventsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/observability/kubernetes-monitors": {
      "post": {
        "tags": [
          "Observability"
        ],
        "summary": "Register and trusts new Kubernetes Monitor.",
        "operationId": "registerKubernetesMonitorBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RegisterKubernetesMonitorCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing the registered agent.",
            "schema": {
              "$ref": "#/definitions/RegisterKubernetesMonitorResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/observability/kubernetes-monitors/{id}": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Get a Kubernetes Monitor by ID",
        "operationId": "getKubernetesMonitorByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Kubernetes Monitor",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Kubernetes Monitor",
            "schema": {
              "$ref": "#/definitions/GetKubernetesMonitorByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Observability"
        ],
        "summary": "Delete a Kubernetes Monitor by ID",
        "operationId": "deleteKubernetesMonitorByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Kubernetes Monitor",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response for deleting a Kubernetes Monitor",
            "schema": {
              "$ref": "#/definitions/DeleteKubernetesMonitorByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/observability/logs/sessions": {
      "post": {
        "tags": [
          "Observability"
        ],
        "summary": "Request the Kubernetes monitor to start sending logs for the specified container",
        "operationId": "beginContainerLogsSessionBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BeginContainerLogsSessionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation response containing any errors that might have occurred during communications with the Kubernetes Monitor",
            "schema": {
              "$ref": "#/definitions/BeginContainerLogsSessionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/observability/logs/sessions/{sessionId}": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request to fetch all the logs for the specified session",
        "operationId": "getContainerLogsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing the logs for a sessionID",
            "schema": {
              "$ref": "#/definitions/GetContainerLogsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/livestatus": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request the live status for a Project/Environment/Tenant",
        "operationId": "getLiveStatusBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "summaryOnly",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "Live status for a given Project/Environment/Tenant",
            "schema": {
              "$ref": "#/definitions/GetLiveStatusResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/machines/{sourceId}/resources/{desiredOrKubernetesMonitoredResourceId}": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Get a detailed summary of a live Kubernetes resource - either a top-level resource or a child resource",
        "operationId": "getLiveKubernetesResourceBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "desiredOrKubernetesMonitoredResourceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing detailed summary of a live kubernetes resource - Either a top level resource or a child resource",
            "schema": {
              "$ref": "#/definitions/GetResourceResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/machines/{sourceId}/resources/{desiredOrKubernetesMonitoredResourceId}/manifest": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request for retrieving the manifest for a live kubernetes resource",
        "operationId": "getLiveKubernetesResourceManifestBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "desiredOrKubernetesMonitoredResourceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the manifest for a live resource",
            "schema": {
              "$ref": "#/definitions/GetResourceManifestResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/machines/{sourceId}/resources/{desiredOrKubernetesMonitoredResourceId}/manifest/v2": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request for retrieving the manifest for a live kubernetes resource",
        "operationId": "getLiveKubernetesResourceManifestV2BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "desiredOrKubernetesMonitoredResourceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the manifest for a live resource",
            "schema": {
              "$ref": "#/definitions/GetResourceManifestResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/{environmentId}/untenanted/livestatus": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request the live status for a Project/Environment/Tenant",
        "operationId": "getLiveStatusBySpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "summaryOnly",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Live status for a given Project/Environment/Tenant",
            "schema": {
              "$ref": "#/definitions/GetLiveStatusResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/{environmentId}/untenanted/machines/{sourceId}/resources/{desiredOrKubernetesMonitoredResourceId}": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Get a detailed summary of a live Kubernetes resource - either a top-level resource or a child resource",
        "operationId": "getLiveKubernetesResourceBySpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "desiredOrKubernetesMonitoredResourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing detailed summary of a live kubernetes resource - Either a top level resource or a child resource",
            "schema": {
              "$ref": "#/definitions/GetResourceResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/{environmentId}/untenanted/machines/{sourceId}/resources/{desiredOrKubernetesMonitoredResourceId}/manifest": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request for retrieving the manifest for a live kubernetes resource",
        "operationId": "getLiveKubernetesResourceManifestBySpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "desiredOrKubernetesMonitoredResourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the manifest for a live resource",
            "schema": {
              "$ref": "#/definitions/GetResourceManifestResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/environments/{environmentId}/untenanted/machines/{sourceId}/resources/{desiredOrKubernetesMonitoredResourceId}/manifest/v2": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request for retrieving the manifest for a live kubernetes resource",
        "operationId": "getLiveKubernetesResourceManifestV2BySpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "desiredOrKubernetesMonitoredResourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the manifest for a live resource",
            "schema": {
              "$ref": "#/definitions/GetResourceManifestResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/observability/agents": {
      "post": {
        "tags": [
          "Observability"
        ],
        "summary": "Register and trusts new Kubernetes Monitor.",
        "operationId": "registerKubernetesMonitor_Legacy0",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RegisterKubernetesMonitorCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing the registered agent.",
            "schema": {
              "$ref": "#/definitions/RegisterKubernetesMonitorResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/observability/events/sessions": {
      "post": {
        "tags": [
          "Observability"
        ],
        "summary": "Request the Kubernetes monitor to start sending events for the specified resource",
        "operationId": "beginResourceEventsSession",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BeginResourceEventsSessionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation response containing a session ID for the event session",
            "schema": {
              "$ref": "#/definitions/BeginResourceEventsSessionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/observability/events/sessions/{sessionId}": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request to fetch all the events for the specified session",
        "operationId": "getResourceEvents",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing the events for a sessionID",
            "schema": {
              "$ref": "#/definitions/GetResourceEventsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/observability/kubernetes-monitors": {
      "post": {
        "tags": [
          "Observability"
        ],
        "summary": "Register and trusts new Kubernetes Monitor.",
        "operationId": "registerKubernetesMonitor",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RegisterKubernetesMonitorCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing the registered agent.",
            "schema": {
              "$ref": "#/definitions/RegisterKubernetesMonitorResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/observability/kubernetes-monitors/{id}": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Get a Kubernetes Monitor by ID",
        "operationId": "getKubernetesMonitorById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Kubernetes Monitor",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Kubernetes Monitor",
            "schema": {
              "$ref": "#/definitions/GetKubernetesMonitorByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Observability"
        ],
        "summary": "Delete a Kubernetes Monitor by ID",
        "operationId": "deleteKubernetesMonitorById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Kubernetes Monitor",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response for deleting a Kubernetes Monitor",
            "schema": {
              "$ref": "#/definitions/DeleteKubernetesMonitorByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/observability/logs/sessions": {
      "post": {
        "tags": [
          "Observability"
        ],
        "summary": "Request the Kubernetes monitor to start sending logs for the specified container",
        "operationId": "beginContainerLogsSession",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BeginContainerLogsSessionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation response containing any errors that might have occurred during communications with the Kubernetes Monitor",
            "schema": {
              "$ref": "#/definitions/BeginContainerLogsSessionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/observability/logs/sessions/{sessionId}": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request to fetch all the logs for the specified session",
        "operationId": "getContainerLogs",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing the logs for a sessionID",
            "schema": {
              "$ref": "#/definitions/GetContainerLogsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/livestatus": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request the live status for a Project/Environment/Tenant",
        "operationId": "getLiveStatus",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "summaryOnly",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "Live status for a given Project/Environment/Tenant",
            "schema": {
              "$ref": "#/definitions/GetLiveStatusResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/machines/{sourceId}/resources/{desiredOrKubernetesMonitoredResourceId}": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Get a detailed summary of a live Kubernetes resource - either a top-level resource or a child resource",
        "operationId": "getLiveKubernetesResource",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "desiredOrKubernetesMonitoredResourceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing detailed summary of a live kubernetes resource - Either a top level resource or a child resource",
            "schema": {
              "$ref": "#/definitions/GetResourceResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/machines/{sourceId}/resources/{desiredOrKubernetesMonitoredResourceId}/manifest": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request for retrieving the manifest for a live kubernetes resource",
        "operationId": "getLiveKubernetesResourceManifest",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "desiredOrKubernetesMonitoredResourceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the manifest for a live resource",
            "schema": {
              "$ref": "#/definitions/GetResourceManifestResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/machines/{sourceId}/resources/{desiredOrKubernetesMonitoredResourceId}/manifest/v2": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request for retrieving the manifest for a live kubernetes resource",
        "operationId": "getLiveKubernetesResourceManifestV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "desiredOrKubernetesMonitoredResourceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the manifest for a live resource",
            "schema": {
              "$ref": "#/definitions/GetResourceManifestResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/untenanted/livestatus": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request the live status for a Project/Environment/Tenant",
        "operationId": "getLiveStatus_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "summaryOnly",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Live status for a given Project/Environment/Tenant",
            "schema": {
              "$ref": "#/definitions/GetLiveStatusResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/untenanted/machines/{sourceId}/resources/{desiredOrKubernetesMonitoredResourceId}": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Get a detailed summary of a live Kubernetes resource - either a top-level resource or a child resource",
        "operationId": "getLiveKubernetesResource_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "desiredOrKubernetesMonitoredResourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing detailed summary of a live kubernetes resource - Either a top level resource or a child resource",
            "schema": {
              "$ref": "#/definitions/GetResourceResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/untenanted/machines/{sourceId}/resources/{desiredOrKubernetesMonitoredResourceId}/manifest": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request for retrieving the manifest for a live kubernetes resource",
        "operationId": "getLiveKubernetesResourceManifest_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "desiredOrKubernetesMonitoredResourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the manifest for a live resource",
            "schema": {
              "$ref": "#/definitions/GetResourceManifestResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/untenanted/machines/{sourceId}/resources/{desiredOrKubernetesMonitoredResourceId}/manifest/v2": {
      "get": {
        "tags": [
          "Observability"
        ],
        "summary": "Request for retrieving the manifest for a live kubernetes resource",
        "operationId": "getLiveKubernetesResourceManifestV2_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "sourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "desiredOrKubernetesMonitoredResourceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the manifest for a live resource",
            "schema": {
              "$ref": "#/definitions/GetResourceManifestResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/octopusservernodes": {
      "get": {
        "tags": [
          "OctopusServerNodes"
        ],
        "summary": "Get a list of Octopus Server Nodes",
        "description": "Lists all of the Octopus Server Nodes participating in the current Octopus Server cluster.",
        "operationId": "getOctopusServerNodes",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "List of IDs",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Octopus Server Nodes",
            "schema": {
              "$ref": "#/definitions/OctopusServerNodeResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/octopusservernodes/all": {
      "get": {
        "tags": [
          "OctopusServerNodes"
        ],
        "summary": "Get all Octopus Server Nodes",
        "description": "Lists the name and ID of all Octopus Server nodes",
        "operationId": "getAllOctopusServerNodes",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested list of Octopus Server Nodes",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/OctopusServerNodeResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/octopusservernodes/ping": {
      "get": {
        "tags": [
          "OctopusServerNodes"
        ],
        "summary": "Ping an octopus server node.",
        "description": "Returns HTTP ImATeapot (418) when the Octopus Server node is draining or offline, otherwise HTTP OK (200). Always returns the node information in the body.",
        "operationId": "pingOctopusServerNode",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Contains information about the octopus server node",
            "schema": {
              "$ref": "#/definitions/LoadBalancerPingResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          },
          "418": {
            "description": "Indicates that the node is draining or offline"
          }
        }
      }
    },
    "/octopusservernodes/summary": {
      "get": {
        "tags": [
          "OctopusServerNodes"
        ],
        "summary": "Return all octopus server nodes in the cluster including their status information",
        "operationId": "getOctopusServerNodesSummary",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The Octopus Server Nodes Summary",
            "schema": {
              "$ref": "#/definitions/OctopusServerClusterSummaryResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/octopusservernodes/{id}": {
      "get": {
        "tags": [
          "OctopusServerNodes"
        ],
        "summary": "Get an Octopus Server Node by ID",
        "operationId": "getOctopusServerNodeById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the OctopusServerNode to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Octopus Server Node",
            "schema": {
              "$ref": "#/definitions/OctopusServerNodeResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "OctopusServerNodes"
        ],
        "summary": "Modify an existing OctopusServerNodeResource by ID",
        "description": "Modifies an existing Octopus Server node.",
        "operationId": "modifyOctopusServerNode",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the OctopusServerNodeResource to modify",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyOctopusServerNodeCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Octopus Server Node was modified, containing the new Node",
            "schema": {
              "$ref": "#/definitions/OctopusServerNodeResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "OctopusServerNodes"
        ],
        "summary": "Delete an existing Octopus Server Node",
        "operationId": "deleteOctopusServerNode",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Octopus Server Node to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Octopus Server Node was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteOctopusServerNodeResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/octopusservernodes/{id}/details": {
      "get": {
        "tags": [
          "OctopusServerNodes"
        ],
        "summary": "Return a count of the running tasks on an octopus server node",
        "operationId": "getOctopusServerNodeDetails",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the OctopusServerNode to load details",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Details about the requested Octopus Server Node",
            "schema": {
              "$ref": "#/definitions/OctopusServerNodeDetailsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/.well-known/openid-configuration": {
      "get": {
        "tags": [
          "OpenIdConnect"
        ],
        "summary": "Get OpenID Connect configuration",
        "operationId": "getOpenIdConfiguration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OpenID Configuration response",
            "schema": {
              "$ref": "#/definitions/GetOpenIdConfigurationResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/authenticate/AzureAD": {
      "post": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "postAzureADUserAuthentication",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/users/authenticate/GenericOidc": {
      "post": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "postGenericOidcUserAuthentication",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/users/authenticate/GoogleApps": {
      "post": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "postGoogleAppsUserAuthentication",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/users/authenticate/OctopusID": {
      "post": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "postOctopusIDUserAuthentication",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/users/authenticate/Okta": {
      "post": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "postOktaUserAuthentication",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/users/authenticatedToken/AzureAD": {
      "get": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "getAzureADUserAuthenticatedPkce",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "postAzureADUserAuthenticated",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/users/authenticatedToken/GenericOidc": {
      "get": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "getGenericOidcUserAuthenticatedPkce",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "postGenericOidcUserAuthenticated",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/users/authenticatedToken/GoogleApps": {
      "get": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "getGoogleAppsUserAuthenticatedPkce",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "postGoogleAppsUserAuthenticated",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/users/authenticatedToken/OctopusID": {
      "get": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "getOctopusIDUserAuthenticatedPkce",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "postOctopusIDUserAuthenticated",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/users/authenticatedToken/Okta": {
      "get": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "getOktaUserAuthenticatedPkce",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "tags": [
          "OpenIDConnect"
        ],
        "operationId": "postOktaUserAuthenticated",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/configuration/open-telemetry-trace-file-export": {
      "get": {
        "tags": [
          "OpenTelemetry"
        ],
        "summary": "Request the open telemetry trace file exporter config",
        "operationId": "getOpenTelemetryTraceFileExportConfiguration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested OpenTelemetry trace file export configuration.",
            "schema": {
              "$ref": "#/definitions/GetOpenTelemetryTraceFileExportConfigurationResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "OpenTelemetry"
        ],
        "summary": "Modify OpenTelemetry trace file export configuration",
        "operationId": "modifyOpenTelemetryTraceFileExportConfiguration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyOpenTelemetryTraceFileExportConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The configuration response for modifying OpenTelemetry trace file export configuration",
            "schema": {
              "$ref": "#/definitions/ModifyOpenTelemetryTraceFileExportConfigurationResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/feeds/{feedId}/packages": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "List packages according to specified search criteria",
        "operationId": "getPackages_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "feedId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "descriptionsOptional",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeMultipleVersions",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeNotes",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includePreRelease",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeWorkItems",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "packageId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "packageIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialMatch",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "preReleaseTag",
            "type": "string"
          },
          {
            "in": "query",
            "name": "take",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "versioningStrategy",
            "description": "SemVer or MostRecentlyPublished.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionTagRegex",
            "description": "Applied to the full version string when set.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Packages",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/PackageResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/feeds/{feedId}/packages/notes": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Get the release notes for the specified package",
        "operationId": "getPackageNotes_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "feedId",
            "description": "ID of the Feed",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "packageId",
            "description": "ID of the package",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "description": "Version of the package",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Package Notes",
            "schema": {
              "type": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/packages": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Get the built in packages",
        "operationId": "getBuiltInPackages_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "filter",
            "description": "Only return the latest versions of packages which contain this value, if specified.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeNotes",
            "description": "Include release notes in the response.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeWorkItems",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "latest",
            "description": "Indicates whether or not to only return the latest version of any packages found.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "nuGetPackageId",
            "description": "Return versions of the NuGet package with this id, if specified.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Built-in Packages",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/packages/bulk": {
      "delete": {
        "tags": [
          "Packages"
        ],
        "summary": "Bulk delete Packages",
        "operationId": "bulkDeletePackages_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BulkDeletePackagesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/packages/bulk/v1": {
      "delete": {
        "tags": [
          "Packages"
        ],
        "summary": "Bulk delete Packages",
        "operationId": "bulkDeletePackagesV1_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BulkDeletePackagesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Packages were deleted",
            "schema": {
              "$ref": "#/definitions/BulkDeletePackagesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/packages/notes": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Request a list of Release Notes for the specified Packages",
        "operationId": "listPackageNotes_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "packageIds",
            "description": "List of package IDs",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Notes",
            "schema": {
              "$ref": "#/definitions/PackageNoteListResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/packages/raw": {
      "post": {
        "tags": [
          "Packages"
        ],
        "summary": "Upload a package to the built in package feed",
        "operationId": "uploadBuiltInPackage_LegacyDefaultSpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "201": {
            "description": "Created PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/packages/raw/validate": {
      "post": {
        "tags": [
          "Packages"
        ],
        "summary": "Validate a package intended for the built in package feed, but does not write the package.",
        "operationId": "validateBuiltInPackage_LegacyDefaultSpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The validation issue detected for a package, or null if the package passes all validation checks.",
            "schema": {
              "$ref": "#/definitions/ValidateBuiltInPackageResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/packages/{id}": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Return package information for the specified package id.",
        "operationId": "getBuiltInPackage_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the package to retrieve.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeNotes",
            "description": "Include release notes in the response.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeWorkItems",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Built-in package",
            "schema": {
              "$ref": "#/definitions/PackageResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Packages"
        ],
        "summary": "Delete the specified Package",
        "operationId": "deletePackage_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Package to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/packages/{id}/raw": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Download the specified package from the built in feed",
        "operationId": "downloadBuiltInPackage_LegacyDefaultSpace",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the package to download.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/packages/{id}/v1": {
      "delete": {
        "tags": [
          "Packages"
        ],
        "summary": "Delete the specified Package",
        "operationId": "deletePackageV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Package to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Package was deleted",
            "schema": {
              "$ref": "#/definitions/DeletePackageResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/packages/{packageId}/{baseVersion}/delta": {
      "post": {
        "tags": [
          "Packages"
        ],
        "summary": "Upload a delta patch for the given file. Used to optimize file upload.",
        "operationId": "uploadBuiltInPackageDelta_LegacyDefaultSpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "packageId",
            "description": "Package ID of the package to be uploaded",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "baseVersion",
            "description": "The version of the package that was used to create the signature",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "201": {
            "description": "Created PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/packages/{packageId}/{version}/delta-signature": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Request the delta-signature for a given package. Used to optimize file upload.",
        "operationId": "getBuiltInPackageDeltaSignature_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "packageId",
            "description": "Package ID of the package to be uploaded",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "version",
            "description": "The version of the package to be uploaded",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the delta-signature for a given package. Used to optimize file upload.",
            "schema": {
              "$ref": "#/definitions/PackageSignatureResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/feeds/{feedId}/packages": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "List packages according to specified search criteria",
        "operationId": "getPackagesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "feedId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "descriptionsOptional",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeMultipleVersions",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeNotes",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includePreRelease",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeWorkItems",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "packageId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "packageIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialMatch",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "preReleaseTag",
            "type": "string"
          },
          {
            "in": "query",
            "name": "take",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "versioningStrategy",
            "description": "SemVer or MostRecentlyPublished.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionTagRegex",
            "description": "Applied to the full version string when set.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Packages",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/PackageResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/feeds/{feedId}/packages/notes": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Get the release notes for the specified package",
        "operationId": "getPackageNotesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "feedId",
            "description": "ID of the Feed",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "packageId",
            "description": "ID of the package",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "description": "Version of the package",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Package Notes",
            "schema": {
              "type": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/packages": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Get the built in packages",
        "operationId": "getBuiltInPackagesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "Only return the latest versions of packages which contain this value, if specified.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeNotes",
            "description": "Include release notes in the response.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeWorkItems",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "latest",
            "description": "Indicates whether or not to only return the latest version of any packages found.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "nuGetPackageId",
            "description": "Return versions of the NuGet package with this id, if specified.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Built-in Packages",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/packages/bulk": {
      "delete": {
        "tags": [
          "Packages"
        ],
        "summary": "Bulk delete Packages",
        "operationId": "bulkDeletePackagesBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BulkDeletePackagesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/packages/bulk/v1": {
      "delete": {
        "tags": [
          "Packages"
        ],
        "summary": "Bulk delete Packages",
        "operationId": "bulkDeletePackagesV1BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BulkDeletePackagesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Packages were deleted",
            "schema": {
              "$ref": "#/definitions/BulkDeletePackagesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/packages/notes": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Request a list of Release Notes for the specified Packages",
        "operationId": "listPackageNotesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "packageIds",
            "description": "List of package IDs",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Notes",
            "schema": {
              "$ref": "#/definitions/PackageNoteListResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/packages/raw": {
      "post": {
        "tags": [
          "Packages"
        ],
        "summary": "Upload a package to the built in package feed",
        "operationId": "uploadBuiltInPackageBySpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "201": {
            "description": "Created PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/packages/raw/validate": {
      "post": {
        "tags": [
          "Packages"
        ],
        "summary": "Validate a package intended for the built in package feed, but does not write the package.",
        "operationId": "validateBuiltInPackageBySpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The validation issue detected for a package, or null if the package passes all validation checks.",
            "schema": {
              "$ref": "#/definitions/ValidateBuiltInPackageResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/packages/{id}": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Return package information for the specified package id.",
        "operationId": "getBuiltInPackageBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the package to retrieve.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeNotes",
            "description": "Include release notes in the response.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeWorkItems",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Built-in package",
            "schema": {
              "$ref": "#/definitions/PackageResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Packages"
        ],
        "summary": "Delete the specified Package",
        "operationId": "deletePackageBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Package to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/packages/{id}/raw": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Download the specified package from the built in feed",
        "operationId": "downloadBuiltInPackageBySpace",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the package to download.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/packages/{id}/v1": {
      "delete": {
        "tags": [
          "Packages"
        ],
        "summary": "Delete the specified Package",
        "operationId": "deletePackageV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Package to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Package was deleted",
            "schema": {
              "$ref": "#/definitions/DeletePackageResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/packages/{packageId}/{baseVersion}/delta": {
      "post": {
        "tags": [
          "Packages"
        ],
        "summary": "Upload a delta patch for the given file. Used to optimize file upload.",
        "operationId": "uploadBuiltInPackageDeltaBySpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "packageId",
            "description": "Package ID of the package to be uploaded",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "baseVersion",
            "description": "The version of the package that was used to create the signature",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "201": {
            "description": "Created PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/packages/{packageId}/{version}/delta-signature": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Request the delta-signature for a given package. Used to optimize file upload.",
        "operationId": "getBuiltInPackageDeltaSignatureBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "packageId",
            "description": "Package ID of the package to be uploaded",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "version",
            "description": "The version of the package to be uploaded",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the delta-signature for a given package. Used to optimize file upload.",
            "schema": {
              "$ref": "#/definitions/PackageSignatureResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/feeds/{feedId}/packages": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "List packages according to specified search criteria",
        "operationId": "getPackages",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "feedId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "descriptionsOptional",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeMultipleVersions",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeNotes",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includePreRelease",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeWorkItems",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "packageId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "packageIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialMatch",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "preReleaseTag",
            "type": "string"
          },
          {
            "in": "query",
            "name": "take",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "versioningStrategy",
            "description": "SemVer or MostRecentlyPublished.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionRange",
            "type": "string"
          },
          {
            "in": "query",
            "name": "versionTagRegex",
            "description": "Applied to the full version string when set.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Packages",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/PackageResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/feeds/{feedId}/packages/notes": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Get the release notes for the specified package",
        "operationId": "getPackageNotes",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "feedId",
            "description": "ID of the Feed",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "packageId",
            "description": "ID of the package",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "version",
            "description": "Version of the package",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Package Notes",
            "schema": {
              "type": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/packages": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Get the built in packages",
        "operationId": "getBuiltInPackages",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "Only return the latest versions of packages which contain this value, if specified.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeNotes",
            "description": "Include release notes in the response.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeWorkItems",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "latest",
            "description": "Indicates whether or not to only return the latest version of any packages found.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "nuGetPackageId",
            "description": "Return versions of the NuGet package with this id, if specified.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Built-in Packages",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/packages/bulk": {
      "delete": {
        "tags": [
          "Packages"
        ],
        "summary": "Bulk delete Packages",
        "operationId": "bulkDeletePackages",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BulkDeletePackagesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/packages/bulk/v1": {
      "delete": {
        "tags": [
          "Packages"
        ],
        "summary": "Bulk delete Packages",
        "operationId": "bulkDeletePackagesV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/BulkDeletePackagesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Packages were deleted",
            "schema": {
              "$ref": "#/definitions/BulkDeletePackagesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/packages/notes": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Request a list of Release Notes for the specified Packages",
        "operationId": "listPackageNotes",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "packageIds",
            "description": "List of package IDs",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Notes",
            "schema": {
              "$ref": "#/definitions/PackageNoteListResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/packages/raw": {
      "post": {
        "tags": [
          "Packages"
        ],
        "summary": "Upload a package to the built in package feed",
        "operationId": "uploadBuiltInPackage",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "201": {
            "description": "Created PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/packages/raw/validate": {
      "post": {
        "tags": [
          "Packages"
        ],
        "summary": "Validate a package intended for the built in package feed, but does not write the package.",
        "operationId": "validateBuiltInPackage",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The validation issue detected for a package, or null if the package passes all validation checks.",
            "schema": {
              "$ref": "#/definitions/ValidateBuiltInPackageResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/packages/{id}": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Return package information for the specified package id.",
        "operationId": "getBuiltInPackage",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the package to retrieve.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeNotes",
            "description": "Include release notes in the response.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeWorkItems",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Built-in package",
            "schema": {
              "$ref": "#/definitions/PackageResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Packages"
        ],
        "summary": "Delete the specified Package",
        "operationId": "deletePackage",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Package to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/packages/{id}/raw": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Download the specified package from the built in feed",
        "operationId": "downloadBuiltInPackage",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the package to download.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/packages/{id}/v1": {
      "delete": {
        "tags": [
          "Packages"
        ],
        "summary": "Delete the specified Package",
        "operationId": "deletePackageV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Package to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Package was deleted",
            "schema": {
              "$ref": "#/definitions/DeletePackageResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/packages/{packageId}/{baseVersion}/delta": {
      "post": {
        "tags": [
          "Packages"
        ],
        "summary": "Upload a delta patch for the given file. Used to optimize file upload.",
        "operationId": "uploadBuiltInPackageDelta",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "packageId",
            "description": "Package ID of the package to be uploaded",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "baseVersion",
            "description": "The version of the package that was used to create the signature",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "201": {
            "description": "Created PackageFromBuiltInFeedResource returned",
            "schema": {
              "$ref": "#/definitions/PackageFromBuiltInFeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/packages/{packageId}/{version}/delta-signature": {
      "get": {
        "tags": [
          "Packages"
        ],
        "summary": "Request the delta-signature for a given package. Used to optimize file upload.",
        "operationId": "getBuiltInPackageDeltaSignature",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "packageId",
            "description": "Package ID of the package to be uploaded",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "version",
            "description": "The version of the package to be uploaded",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the delta-signature for a given package. Used to optimize file upload.",
            "schema": {
              "$ref": "#/definitions/PackageSignatureResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/parentEnvironments": {
      "post": {
        "tags": [
          "ParentEnvironments"
        ],
        "summary": "Create a new parent environment.",
        "operationId": "createParentEnvironmentBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateParentEnvironmentCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateParentEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/parentEnvironments/{environmentId}": {
      "put": {
        "tags": [
          "ParentEnvironments"
        ],
        "summary": "Modify an existing parent environment.",
        "operationId": "modifyParentEnvironmentBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyParentEnvironmentCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The parent environment after modifications have been applied.",
            "schema": {
              "$ref": "#/definitions/ModifyParentEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/parentEnvironments/{id}": {
      "get": {
        "tags": [
          "ParentEnvironments"
        ],
        "summary": "Get a specific Parent Environment",
        "operationId": "getParentEnvironmentBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Parent Environment to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Parent Environment",
            "schema": {
              "$ref": "#/definitions/GetParentEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ParentEnvironments"
        ],
        "summary": "Delete an existing Parent Environment",
        "operationId": "deleteParentEnvironmentBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Parent Environment to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/parentEnvironments": {
      "post": {
        "tags": [
          "ParentEnvironments"
        ],
        "summary": "Create a new parent environment.",
        "operationId": "createParentEnvironment",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateParentEnvironmentCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateParentEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/parentEnvironments/{environmentId}": {
      "put": {
        "tags": [
          "ParentEnvironments"
        ],
        "summary": "Modify an existing parent environment.",
        "operationId": "modifyParentEnvironment",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyParentEnvironmentCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The parent environment after modifications have been applied.",
            "schema": {
              "$ref": "#/definitions/ModifyParentEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/parentEnvironments/{id}": {
      "get": {
        "tags": [
          "ParentEnvironments"
        ],
        "summary": "Get a specific Parent Environment",
        "operationId": "getParentEnvironment",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Parent Environment to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Parent Environment",
            "schema": {
              "$ref": "#/definitions/GetParentEnvironmentResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ParentEnvironments"
        ],
        "summary": "Delete an existing Parent Environment",
        "operationId": "deleteParentEnvironment",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Parent Environment to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/performanceconfiguration": {
      "get": {
        "tags": [
          "Performance"
        ],
        "summary": "Request the current performance configuration",
        "operationId": "getPerformanceConfiguration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The current performance configuration",
            "schema": {
              "$ref": "#/definitions/PerformanceConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Performance"
        ],
        "summary": "Set the performance configuration",
        "operationId": "setPerformanceConfiguration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/SetPerformanceConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The updated performance configuration",
            "schema": {
              "$ref": "#/definitions/PerformanceConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/permissions/all": {
      "get": {
        "tags": [
          "Permissions"
        ],
        "summary": "Get all the available permissions and their descriptions and restrictions",
        "operationId": "getPermissionDescriptions",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A dictionary keyed by permission with their description",
            "schema": {
              "type": "object",
              "properties": {
                "AdministerSystem": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProjectEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProjectView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProjectCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProjectDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProcessView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProcessEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "VariableEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "VariableEditUnscoped": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "VariableView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "VariableViewUnscoped": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ReleaseCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ReleaseView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ReleaseEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ReleaseDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "DefectReport": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "DefectResolve": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "DeploymentCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "DeploymentDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "DeploymentView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "EnvironmentView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "EnvironmentCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "EnvironmentEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "EnvironmentDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "MachineCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "MachineEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "MachineView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "MachineDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ArtifactView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ArtifactCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ArtifactEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ArtifactDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "FeedView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "EventView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "LibraryVariableSetView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "LibraryVariableSetCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "LibraryVariableSetEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "LibraryVariableSetDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProjectGroupView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProjectGroupCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProjectGroupEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProjectGroupDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TeamCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TeamView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TeamEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TeamDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "UserView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "UserInvite": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "UserRoleView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "UserRoleEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TaskView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TaskCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TaskCancel": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TaskEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TaskPrioritize": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "InterruptionView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "InterruptionSubmit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "InterruptionViewSubmitResponsible": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "BuiltInFeedPush": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "BuiltInFeedAdminister": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "BuiltInFeedDownload": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ActionTemplateView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ActionTemplateCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ActionTemplateEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ActionTemplateDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "LifecycleCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "LifecycleView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "LifecycleEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "LifecycleDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "AccountView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "AccountEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "AccountCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "AccountDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TenantCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TenantEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TenantView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TenantDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TagSetCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TagSetEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TagSetDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TelemetryView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "MachinePolicyCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "MachinePolicyView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "MachinePolicyEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "MachinePolicyDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProxyCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProxyView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProxyEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ProxyDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "SubscriptionCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "SubscriptionView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "SubscriptionEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "SubscriptionDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TriggerCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TriggerView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TriggerEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TriggerDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "CertificateView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "CertificateCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "CertificateEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "CertificateDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "CertificateExportPrivateKey": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "UserEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ConfigureServer": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "FeedEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "WorkerView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "WorkerEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "SpaceEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "SpaceView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "SpaceDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "SpaceCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "BuildInformationPush": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "BuildInformationAdminister": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "RunbookView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "RunbookEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "RunbookSnapshotCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "RunbookRunView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "RunbookRunDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "RunbookRunCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "GitCredentialView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "GitCredentialEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "EventRetentionDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "EventRetentionView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "InsightsReportView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "InsightsReportCreate": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "InsightsReportEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "InsightsReportDelete": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "DeploymentFreezeAdminister": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TargetTagView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "TargetTagAdminister": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "PlatformHubView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "PlatformHubEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "RetentionAdminister": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "FeatureToggleEdit": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "ApprovalPolicyAdminister": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "SshKnownHostsAdminister": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "SshKnownHostsView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "AiAgentTranscriptView": {
                  "$ref": "#/definitions/PermissionDescription"
                },
                "DeployedResourceAdminister": {
                  "$ref": "#/definitions/PermissionDescription"
                }
              },
              "additionalProperties": false
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/accounts": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get Platform Hub accounts",
        "operationId": "getPlatformHubAccounts",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "accountType",
            "description": "The type of accounts to return.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Filter by partial name match",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of records to skip",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of records to take",
            "type": "integer",
            "format": "int32"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/PlatformHubAccountResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Create a new Platform Hub account",
        "operationId": "createPlatformHubAccount",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreatePlatformHubAccountCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreatePlatformHubAccountResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/accounts/{id}": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get a specific Platform Hub account",
        "operationId": "getPlatformHubAccountById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the account to get",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "An Account within the Platform Hub",
            "schema": {
              "$ref": "#/definitions/PlatformHubAccountResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Modify an existing Platform Hub account",
        "operationId": "modifyPlatformHubAccount",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyPlatformHubAccountCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Indicates that the Platform Hub account was successfully modified.",
            "schema": {
              "$ref": "#/definitions/ModifyPlatformHubAccountResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Delete an existing Platform Hub account",
        "operationId": "deletePlatformHubAccount",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the account to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Platform Hub account has been deleted",
            "schema": {
              "$ref": "#/definitions/DeletePlatformHubAccountResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/certificates": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get Platform Hub certificates.",
        "operationId": "getPlatformHubCertificates",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "archived",
            "description": "If true, returns only archived certificates. Otherwise, returns only non-archived certificates.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "firstResult",
            "description": "Certificate ID which if specified, adds the certificate with matching ID to the result if it is not already included.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Comma delimited list of certificate IDs used to filter the result.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "orderBy",
            "description": "If the value is 'recent' (case-insensitive), the result is sorted by Created instead of NotAfter.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Alternative parameter to Search; filters certificates by Name, Subject, or Thumbprint.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "search",
            "description": "Filters certificates by Name, Subject, or Thumbprint.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 15",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Platform Hub certificates.",
            "schema": {
              "$ref": "#/definitions/PlatformHubCertificateResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Create a new Platform Hub certificate.",
        "operationId": "createPlatformHubCertificate",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreatePlatformHubCertificateCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/PlatformHubCertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/certificates/generate": {
      "post": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Create a self-signed Platform Hub certificate.",
        "operationId": "createSelfSignedPlatformHubCertificate",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateSelfSignedPlatformHubCertificateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The created self-signed Platform Hub certificate.",
            "schema": {
              "$ref": "#/definitions/PlatformHubCertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/certificates/{id}": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get a Platform Hub certificate by ID or Thumbprint.",
        "operationId": "getPlatformHubCertificateById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Platform Hub certificate.",
            "schema": {
              "$ref": "#/definitions/PlatformHubCertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Modify an existing Platform Hub certificate.",
        "operationId": "modifyPlatformHubCertificate",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyPlatformHubCertificateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified Platform Hub certificate.",
            "schema": {
              "$ref": "#/definitions/PlatformHubCertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Delete an existing archived Platform Hub certificate.",
        "operationId": "deletePlatformHubCertificate",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Platform Hub certificate has been deleted.",
            "schema": {
              "$ref": "#/definitions/DeletePlatformHubCertificateResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/certificates/{id}/archive": {
      "post": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Archive an existing Platform Hub certificate.",
        "operationId": "archivePlatformHubCertificate",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Platform Hub certificate has been archived.",
            "schema": {
              "$ref": "#/definitions/ArchivePlatformHubCertificateResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/certificates/{id}/export": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Export the Platform Hub certificate.",
        "operationId": "exportPlatformHubCertificate",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "format",
            "type": "string",
            "enum": [
              "Pkcs12",
              "Der",
              "Pem",
              "Unknown"
            ]
          },
          {
            "in": "query",
            "name": "includePrivateKey",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "password",
            "type": "string"
          },
          {
            "in": "query",
            "name": "pemOptions",
            "type": "string",
            "enum": [
              "PrimaryOnly",
              "PrimaryAndChain",
              "ChainOnly"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/certificates/{id}/replace": {
      "post": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Replace an existing Platform Hub certificate with another.",
        "operationId": "replacePlatformHubCertificate",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ReplacePlatformHubCertificateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Platform Hub certificate has been replaced.",
            "schema": {
              "$ref": "#/definitions/PlatformHubCertificateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/certificates/{id}/unarchive": {
      "post": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Unarchive an existing archived Platform Hub certificate.",
        "operationId": "unarchivePlatformHubCertificate",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Platform Hub certificate has been unarchived.",
            "schema": {
              "$ref": "#/definitions/UnarchivePlatformHubCertificateResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/certificates/{id}/usages": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get usages for a Platform Hub certificate.",
        "operationId": "getPlatformHubCertificateUsages",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The published template versions that use a Platform Hub certificate.",
            "schema": {
              "$ref": "#/definitions/PlatformHubCertificateUsageResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/feeds": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get a list of Platform Hub Feeds",
        "operationId": "getPlatformHubFeeds",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "feedType",
            "description": "The feed types to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "The feed ids to be matched, provided as a comma separated list of strings",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a feed to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "The partial name of feeds to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Platform Hub Feeds",
            "schema": {
              "$ref": "#/definitions/PlatformHubFeedResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Create a new Platform Hub Feed",
        "operationId": "createPlatformHubFeed",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreatePlatformHubFeedCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/PlatformHubFeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/feeds/{id}": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get a Platform Hub Feed by its id",
        "operationId": "getPlatformHubFeedById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Platform Hub Feed to get",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A Feed within the Platform Hub",
            "schema": {
              "$ref": "#/definitions/PlatformHubFeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Modify a Platform Hub Feed",
        "operationId": "modifyPlatformHubFeed",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyPlatformHubFeedCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The response returned from the request to modify a platform hub feed.",
            "schema": {
              "$ref": "#/definitions/PlatformHubFeedResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Delete an existing Platform Hub Feed",
        "operationId": "deletePlatformHubFeed",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Platform Hub Feed to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Platform Hub feed has been deleted",
            "schema": {
              "$ref": "#/definitions/DeletePlatformHubFeedResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/feeds/{id}/packages/search": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Search the specified platform hub feed for packages based on the provided search term",
        "operationId": "getPlatformHubFeedPackageDescriptorsSearch",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "packageType",
            "description": "The package type to filter results by. Used by feeds that can contain multiple package types. Valid values are ContainerImage and HelmChart.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 20",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "term",
            "description": "The term to search for.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a paginated collection of searched package descriptions in platform hub",
            "schema": {
              "$ref": "#/definitions/PlatformHubPackageDescriptionResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/feeds/{id}/packages/versions": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "List available package versions for the specified platform hub feed and package.",
        "operationId": "getPlatformHubFeedPackageVersions",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the feed resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "Version number text to filter by.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includePreRelease",
            "description": "Flag to include pre-release versions, defaults to true.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "includeReleaseNotes",
            "description": "Flag to include release notes, defaults to false.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "packageId",
            "description": "The id of the package.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "preReleaseTag",
            "description": "The semver tag regex pattern to filter by.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 20",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "versionRange",
            "description": "The range of versions to filter by.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a paginated collection of package versions returned from a search",
            "schema": {
              "$ref": "#/definitions/PlatformHubPackageVersionResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/git-credentials": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get Platform Hub Git credentials",
        "operationId": "getPlatformHubGitCredentials",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "name",
            "description": "Filter by partial name match",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of records to skip",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of records to take",
            "type": "integer",
            "format": "int32"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/PlatformHubGitCredentialResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Create a new Platform Hub Git credential",
        "operationId": "createPlatformHubGitCredential",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreatePlatformHubGitCredentialCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreatePlatformHubGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/git-credentials/v2": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get Platform Hub Git credentials (V2)",
        "operationId": "getPlatformHubGitCredentialsV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "name",
            "description": "Filter by partial name match",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/PlatformHubGitCredentialResourceV2PaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Create a new Platform Hub Git credential",
        "operationId": "createPlatformHubGitCredentialV2",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreatePlatformHubGitCredentialCommandV2"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreatePlatformHubGitCredentialResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/git-credentials/{id}": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get a specific Platform Hub Git credential",
        "operationId": "getPlatformHubGitCredentialById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to get",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Platform Hub Git Credential",
            "schema": {
              "$ref": "#/definitions/PlatformHubGitCredentialResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Modify an existing Platform Hub Git credential",
        "operationId": "modifyPlatformHubGitCredential",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyPlatformHubGitCredentialCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Indicates that the Platform Hub Git Credential was successfully modified.",
            "schema": {
              "$ref": "#/definitions/ModifyPlatformHubGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Delete an existing Platform Hub Git credential",
        "operationId": "deletePlatformHubGitCredential",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Platform Hub Git Credential has been deleted",
            "schema": {
              "$ref": "#/definitions/DeletePlatformHubGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/git-credentials/{id}/v2": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get a specific Platform Hub Git credential (V2)",
        "operationId": "getPlatformHubGitCredentialByIdV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to get",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A Platform Hub Git credential (V2)",
            "schema": {
              "$ref": "#/definitions/PlatformHubGitCredentialResourceV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Modify an existing Platform Hub Git credential",
        "operationId": "modifyPlatformHubGitCredentialV2",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyPlatformHubGitCredentialCommandV2"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Indicates that the Platform Hub Git Credential was successfully modified.",
            "schema": {
              "$ref": "#/definitions/ModifyPlatformHubGitCredentialResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/git/branches": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Request the list of Branches for the Platform Hub",
        "operationId": "getPlatformHubBranches",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GitBranchResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Create a branch given the base git ref, and the new branch's name",
        "operationId": "createPlatformHubBranch",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreatePlatformHubBranchCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/GitBranchResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/git/tags": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Request a list of Git Tags for the Platform Hub",
        "operationId": "getPlatformHubTags",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GitTagResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/github/connections": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get GitHub App connections for the Platform Hub",
        "description": "Gets a set of GitHub App connections for the Platform Hub.",
        "operationId": "getPlatformHubGitHubAppConnections",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "All GitHub App connections for Platform Hub",
            "schema": {
              "$ref": "#/definitions/GetPlatformHubGitHubAppConnectionsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Create a new GitHub App connection in Platform Hub",
        "operationId": "createPlatformHubGitHubAppConnection",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreatePlatformHubGitHubAppConnectionCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "type": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/github/connections/{id}": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get a single PlatformHub GitHub app connection by id",
        "operationId": "getPlatformHubGitHubAppConnectionById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A PlatformHub GitHub app connection",
            "schema": {
              "$ref": "#/definitions/GetPlatformHubGitHubAppConnectionByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Update a Platform Hub GitHub App connection with a new set of repositories",
        "operationId": "modifyPlatformHubGitHubAppConnection",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyPlatformHubGitHubAppConnectionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Platform Hub GitHub app connection modified result",
            "schema": {
              "$ref": "#/definitions/ModifyPlatformHubGitHubAppConnectionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Delete a PlatformHub GitHub App connection by id",
        "operationId": "deletePlatformHubGitHubAppConnectionById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the GitHub connection to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the PlatformHub GitHub App connection has been deleted",
            "schema": {
              "$ref": "#/definitions/DeletePlatformHubGitHubAppConnectionByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/github/connections/{id}/recover": {
      "post": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Recover a platfrom hub GitHub App connection after the registration has changed",
        "operationId": "recoverPlatformHubGitHubAppConnection",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RecoverPlatformHubGitHubAppConnectionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Platform Hub GitHub app connection recovery result",
            "schema": {
              "$ref": "#/definitions/RecoverPlatformHubGitHubAppConnectionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/github/connections/{id}/refresh": {
      "post": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Refresh the Platform Hub GitHub App connection token.",
        "operationId": "refreshPlatformHubGitHubAppConnectionById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Platform Hub GitHub app connection has been refreshed",
            "schema": {
              "$ref": "#/definitions/RefreshPlatformHubGitHubAppConnectionByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/github/installations": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get a list of GitHub organisations accessible to the current GitHub OAuth user. Request will fail if the user does not have a valid GitHub OAuth token.",
        "operationId": "getPlatformHubGitHubAppInstallationsForUser",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "excludeConnected",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "List of GitHub organisations accessible to the current GitHub OAuth user",
            "schema": {
              "$ref": "#/definitions/GetPlatformHubGitHubAppInstallationsForUserResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/versioncontrol": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get platform hub version control settings configuration",
        "operationId": "getPlatformHubVersionControlSettings",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The version control settings for the Platform Hub",
            "schema": {
              "$ref": "#/definitions/PlatformHubVersionControlSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Update the platform hub's existing version control settings configuration",
        "operationId": "modifyPlatformHubVersionControlSettings",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyPlatformHubVersionControlSettingsCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The version control settings for the Platform Hub",
            "schema": {
              "$ref": "#/definitions/PlatformHubVersionControlSettingsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/{gitRef}/processtemplates": {
      "get": {
        "tags": [
          "PlatformHub"
        ],
        "summary": "Get a paginated list of process templates from the specified Git reference (sorted by name).",
        "operationId": "getProcessTemplatesByGitRef",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of process templates (sorted by name).",
            "schema": {
              "$ref": "#/definitions/GetProcessTemplatesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "Create a new process template in the provided source",
        "operationId": "createProcessTemplateByGitRef",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProcessTemplateCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProcessTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/processtemplates/{slug}/share": {
      "get": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "Get the sharing configuration for a given process template",
        "operationId": "getProcessTemplateSharingConfiguration",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The sharing configuration of the requested process template",
            "schema": {
              "$ref": "#/definitions/GetProcessTemplateSharingConfigurationResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/processtemplates/{slug}/versions": {
      "get": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "List the process template versions for a given process template",
        "operationId": "getProcessTemplateVersions",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "fromPublishedDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "toPublishedDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "versionMask",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested process template version",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProcessTemplateVersionResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/processtemplates/{slug}/{versionMask}": {
      "get": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "Retrieve a single published process template and its version by version mask (no space context)",
        "operationId": "getPublishedProcessTemplateByVersionMask",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "versionMask",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested published process template and its version",
            "schema": {
              "$ref": "#/definitions/GetPublishedProcessTemplateByVersionMaskResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/{gitRef}/processtemplates/{slug}": {
      "get": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "Get a single process template by slug",
        "operationId": "getProcessTemplateBySlugByGitRef",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ProcessTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/{gitref}/processtemplates/{slug}": {
      "put": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "Modify an existing process template",
        "operationId": "modifyProcessTemplate",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitref",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProcessTemplateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ProcessTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "Delete an existing process template",
        "operationId": "deleteProcessTemplate",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitref",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/DeleteProcessTemplateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/{gitRef}/processtemplates/{slug}/share": {
      "post": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "Share new process template to spaces",
        "operationId": "shareProcessTemplateByGitRef",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ShareProcessTemplateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing the results of the share process template command",
            "schema": {
              "$ref": "#/definitions/ShareProcessTemplateResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/{gitRef}/processtemplates/{slug}/variables/names": {
      "get": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "Get all the available variable names for a process template",
        "operationId": "getProcessTemplateVariableNamesByGitRef",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/{gitRef}/processtemplates/{slug}/versions": {
      "post": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "Create a process template version",
        "operationId": "createProcessTemplateVersionByGitRef",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProcessTemplateVersionCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProcessTemplateVersionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/processtemplates/{slug}/{versionMask}": {
      "get": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "Retrieve a single process template and its version by version mask",
        "operationId": "getProcessTemplateByVersionMaskBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "versionMask",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested process template and its version",
            "schema": {
              "$ref": "#/definitions/GetProcessTemplateByVersionMaskResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/processtemplates/{slug}/{versionMask}/icon": {
      "get": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "Get the icon for a given process template version",
        "operationId": "getProcessTemplateVersionIconBySpace",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "versionMask",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/processtemplates/{slug}/{versionMask}": {
      "get": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "Retrieve a single process template and its version by version mask",
        "operationId": "getProcessTemplateByVersionMask",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "versionMask",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested process template and its version",
            "schema": {
              "$ref": "#/definitions/GetProcessTemplateByVersionMaskResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/processtemplates/{slug}/{versionMask}/icon": {
      "get": {
        "tags": [
          "ProcessTemplates"
        ],
        "summary": "Get the icon for a given process template version",
        "operationId": "getProcessTemplateVersionIcon",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "versionMask",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/progression/runbooks/taskRuns": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Return a list of runbook dashboard items, filtered by various criteria including projectIds, environmentIds, tenantIds, tenantTags, runbookIds, runbookTags, taskIds",
        "operationId": "getRunbookProgressionTaskRuns_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "environmentIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projectIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbookIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbookTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "taskIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of runbook dashboard items",
            "schema": {
              "$ref": "#/definitions/RunbooksDashboardItemResourceCollection"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/progression/runbooks/{runbookId}": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a runbook in the environment lifecycle.",
        "operationId": "getRunbookProgression_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Progression information",
            "schema": {
              "$ref": "#/definitions/RunbooksProgressionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/progression/runbooks/{runbookId}/v1": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a runbook in the environment lifecycle.",
        "operationId": "getRunbookProgressionV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Progression information",
            "schema": {
              "$ref": "#/definitions/GetRunbookProgressionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/progression/{projectId}": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a release in the environment lifecycle.",
        "operationId": "getProjectProgression_LegacyDefaultSpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseHistoryCount",
            "description": "Number of releases to include per environment/channel/tenant combination. Defaults to 3. Maximum allowed is 100.",
            "type": "integer",
            "format": "int32",
            "maximum": 100,
            "minimum": 1
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Progression information",
            "schema": {
              "$ref": "#/definitions/ProgressionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/progression": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a release in the environment lifecycle.",
        "operationId": "getProjectProgression_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseHistoryCount",
            "description": "Number of releases to include per environment/channel/tenant combination. Defaults to 3. Maximum allowed is 100.",
            "type": "integer",
            "format": "int32",
            "maximum": 100,
            "minimum": 1
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Progression information",
            "schema": {
              "$ref": "#/definitions/ProgressionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/progression/v1": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a release in the environment lifecycle.",
        "operationId": "getProjectProgressionV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseHistoryCount",
            "description": "Number of releases to include per environment/channel/tenant combination. Defaults to 3. Maximum allowed is 100.",
            "type": "integer",
            "format": "int32",
            "maximum": 100,
            "minimum": 1
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Progression information",
            "schema": {
              "$ref": "#/definitions/GetProjectProgressionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/progression/runbooks/taskRuns": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Return a list of runbook dashboard items, filtered by various criteria including projectIds, environmentIds, tenantIds, tenantTags, runbookIds, runbookTags, taskIds",
        "operationId": "getRunbookProgressionTaskRunsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projectIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbookIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbookTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "taskIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of runbook dashboard items",
            "schema": {
              "$ref": "#/definitions/RunbooksDashboardItemResourceCollection"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/progression/runbooks/{runbookId}": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a runbook in the environment lifecycle.",
        "operationId": "getRunbookProgressionBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Progression information",
            "schema": {
              "$ref": "#/definitions/RunbooksProgressionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/progression/runbooks/{runbookId}/v1": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a runbook in the environment lifecycle.",
        "operationId": "getRunbookProgressionV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Progression information",
            "schema": {
              "$ref": "#/definitions/GetRunbookProgressionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/progression/{projectId}": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a release in the environment lifecycle.",
        "operationId": "getProjectProgressionBySpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseHistoryCount",
            "description": "Number of releases to include per environment/channel/tenant combination. Defaults to 3. Maximum allowed is 100.",
            "type": "integer",
            "format": "int32",
            "maximum": 100,
            "minimum": 1
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Progression information",
            "schema": {
              "$ref": "#/definitions/ProgressionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/progression": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a release in the environment lifecycle.",
        "operationId": "getProjectProgressionBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseHistoryCount",
            "description": "Number of releases to include per environment/channel/tenant combination. Defaults to 3. Maximum allowed is 100.",
            "type": "integer",
            "format": "int32",
            "maximum": 100,
            "minimum": 1
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Progression information",
            "schema": {
              "$ref": "#/definitions/ProgressionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/progression/v1": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a release in the environment lifecycle.",
        "operationId": "getProjectProgressionV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseHistoryCount",
            "description": "Number of releases to include per environment/channel/tenant combination. Defaults to 3. Maximum allowed is 100.",
            "type": "integer",
            "format": "int32",
            "maximum": 100,
            "minimum": 1
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Progression information",
            "schema": {
              "$ref": "#/definitions/GetProjectProgressionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/progression/runbooks/taskRuns": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Return a list of runbook dashboard items, filtered by various criteria including projectIds, environmentIds, tenantIds, tenantTags, runbookIds, runbookTags, taskIds",
        "operationId": "getRunbookProgressionTaskRuns",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projectIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbookIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbookTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "taskIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantTags",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of runbook dashboard items",
            "schema": {
              "$ref": "#/definitions/RunbooksDashboardItemResourceCollection"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/progression/runbooks/{runbookId}": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a runbook in the environment lifecycle.",
        "operationId": "getRunbookProgression",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Progression information",
            "schema": {
              "$ref": "#/definitions/RunbooksProgressionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/progression/runbooks/{runbookId}/v1": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a runbook in the environment lifecycle.",
        "operationId": "getRunbookProgressionV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Progression information",
            "schema": {
              "$ref": "#/definitions/GetRunbookProgressionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/progression/{projectId}": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a release in the environment lifecycle.",
        "operationId": "getProjectProgression_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseHistoryCount",
            "description": "Number of releases to include per environment/channel/tenant combination. Defaults to 3. Maximum allowed is 100.",
            "type": "integer",
            "format": "int32",
            "maximum": 100,
            "minimum": 1
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Progression information",
            "schema": {
              "$ref": "#/definitions/ProgressionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/progression": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a release in the environment lifecycle.",
        "operationId": "getProjectProgression",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseHistoryCount",
            "description": "Number of releases to include per environment/channel/tenant combination. Defaults to 3. Maximum allowed is 100.",
            "type": "integer",
            "format": "int32",
            "maximum": 100,
            "minimum": 1
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Progression information",
            "schema": {
              "$ref": "#/definitions/ProgressionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/progression/v1": {
      "get": {
        "tags": [
          "Progression"
        ],
        "summary": "Get the progress of a release in the environment lifecycle.",
        "operationId": "getProjectProgressionV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "releaseHistoryCount",
            "description": "Number of releases to include per environment/channel/tenant combination. Defaults to 3. Maximum allowed is 100.",
            "type": "integer",
            "format": "int32",
            "maximum": 100,
            "minimum": 1
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Progression information",
            "schema": {
              "$ref": "#/definitions/GetProjectProgressionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projectgroups": {
      "get": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Get a paginated list of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getProjectGroups_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Project Group IDs to filter on",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Project Group to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to limit the set of retrieved Project Groups to. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
            "schema": {
              "$ref": "#/definitions/ProjectGroupResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Create a new project group.",
        "operationId": "createProjectGroup_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProjectGroupCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProjectGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projectgroups/all": {
      "get": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "List the name and ID of all of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllProjectGroups_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The name and ID of all of the Project Groups in the supplied Octopus Deploy Space. The results are sorted alphabetically by name.\"",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectGroupResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projectgroups/{id}": {
      "get": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Get a Project Group by ID",
        "operationId": "getProjectGroupById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ProjectGroup to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested project group",
            "schema": {
              "$ref": "#/definitions/ProjectGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Modify an existing project group.",
        "operationId": "modifyProjectGroup_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the project group.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectGroupCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified project group",
            "schema": {
              "$ref": "#/definitions/ProjectGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Delete an existing Project Group",
        "operationId": "deleteProjectGroup_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the project group to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projectgroups/{id}/projects": {
      "get": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Get a paginated list of the Projects that belong to the given Project Group",
        "operationId": "getProjectGroupProjects_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the project group",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the Projects that belong to the given Project Group",
            "schema": {
              "$ref": "#/definitions/ProjectResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projectgroups": {
      "get": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Get a paginated list of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getProjectGroupsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Project Group IDs to filter on",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Project Group to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to limit the set of retrieved Project Groups to. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
            "schema": {
              "$ref": "#/definitions/ProjectGroupResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Create a new project group.",
        "operationId": "createProjectGroupBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProjectGroupCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProjectGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projectgroups/all": {
      "get": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "List the name and ID of all of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllProjectGroupsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The name and ID of all of the Project Groups in the supplied Octopus Deploy Space. The results are sorted alphabetically by name.\"",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectGroupResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projectgroups/{id}": {
      "get": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Get a Project Group by ID",
        "operationId": "getProjectGroupByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ProjectGroup to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested project group",
            "schema": {
              "$ref": "#/definitions/ProjectGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Modify an existing project group.",
        "operationId": "modifyProjectGroupBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the project group.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectGroupCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified project group",
            "schema": {
              "$ref": "#/definitions/ProjectGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Delete an existing Project Group",
        "operationId": "deleteProjectGroupBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the project group to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projectgroups/{id}/projects": {
      "get": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Get a paginated list of the Projects that belong to the given Project Group",
        "operationId": "getProjectGroupProjectsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the project group",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the Projects that belong to the given Project Group",
            "schema": {
              "$ref": "#/definitions/ProjectResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projectgroups": {
      "get": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Get a paginated list of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getProjectGroups",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A comma separated list of Project Group IDs to filter on",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Project Group to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to limit the set of retrieved Project Groups to. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
            "schema": {
              "$ref": "#/definitions/ProjectGroupResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Create a new project group.",
        "operationId": "createProjectGroup",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProjectGroupCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProjectGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projectgroups/all": {
      "get": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "List the name and ID of all of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllProjectGroups",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The name and ID of all of the Project Groups in the supplied Octopus Deploy Space. The results are sorted alphabetically by name.\"",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectGroupResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projectgroups/{id}": {
      "get": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Get a Project Group by ID",
        "operationId": "getProjectGroupById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the ProjectGroup to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested project group",
            "schema": {
              "$ref": "#/definitions/ProjectGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Modify an existing project group.",
        "operationId": "modifyProjectGroup",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the project group.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectGroupCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified project group",
            "schema": {
              "$ref": "#/definitions/ProjectGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Delete an existing Project Group",
        "operationId": "deleteProjectGroup",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the project group to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projectgroups/{id}/projects": {
      "get": {
        "tags": [
          "ProjectGroups"
        ],
        "summary": "Get a paginated list of the Projects that belong to the given Project Group",
        "operationId": "getProjectGroupProjects",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the project group",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the Projects that belong to the given Project Group",
            "schema": {
              "$ref": "#/definitions/ProjectResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "List all of the projects in the supplied Octopus Deploy Space, from all project groups. The results will be sorted alphabetically by name.",
        "operationId": "getProjects_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "clonedFromProjectId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "(Obsolete) A partial or complete name to limit the set of retrieved Projects to. This will perform a \"contains\" style match against the supplied name or name-fragment. Left for backwards compatibility.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Projects to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List all of the projects in the supplied Octopus Deploy Space, from all project groups. The results will be sorted alphabetically by name.",
            "schema": {
              "$ref": "#/definitions/ProjectResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Create a new project.",
        "operationId": "createProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProjectCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProjectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/all": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "List all of the projects in the supplied Octopus Deploy Space.",
        "operationId": "getAllProjects_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "Project Ids of Projects to filter results to",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "All of the project resources in the supplied Octopus Deploy Space.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{id}/logo": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get the logo associated with the project.",
        "operationId": "getProjectLogo_LegacyDefaultSpace",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the resource",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectIdOrSlug}/badge/{environmentIdOrSlug}/latest_release": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get Project Badge based on relevant parameters",
        "operationId": "getProjectBadgeImage_LegacyDefaultSpace",
        "produces": [
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectIdOrSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentIdOrSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeFailed",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "label",
            "type": "string"
          },
          {
            "in": "query",
            "name": "style",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectIdOrSlug}/badge/{environmentIdOrSlug}/latest_release.json": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get Project Badge based on relevant parameters",
        "operationId": "getProjectBadgeJson_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectIdOrSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentIdOrSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeFailed",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Get Project Badge JSON data",
            "schema": {
              "$ref": "#/definitions/GetProjectBadgeJsonResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a Project by ID or slug.",
        "operationId": "getProjectByIdOrSlug_LegacyDefaultSpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to return",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project.",
            "schema": {
              "$ref": "#/definitions/ProjectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Projects"
        ],
        "summary": "Modify an existing Project",
        "operationId": "modifyProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project to modify",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that the Project has been modified, containing the updated Project",
            "schema": {
              "$ref": "#/definitions/ProjectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Projects"
        ],
        "summary": "Delete an existing Project",
        "operationId": "deleteProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/git/connectivity-test": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Test the Git settings to make sure we can connect.",
        "operationId": "testGitSettings_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/TestGitSettingsCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The results from testing git settings.",
            "schema": {
              "$ref": "#/definitions/TestGitSettingsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/git/convert": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Convert an existing project to store its configuration in version control.",
        "operationId": "convertProjectToVersionControlled_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ConvertProjectToVersionControlledCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Empty response indicating the Project was converted",
            "schema": {
              "$ref": "#/definitions/ConvertProjectToVersionControlledResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/git/validate": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Validate the provided git ref",
        "operationId": "validateGitRef_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ValidateGitRefCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Validated Git ref or error message",
            "schema": {
              "$ref": "#/definitions/ValidateGitRefResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        },
        "deprecated": true
      }
    },
    "/projects/{projectId}/logo": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Update the logo associated with the project.",
        "operationId": "modifyProjectLogo_LegacyDefaultSpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project to change logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Projects"
        ],
        "summary": "Update the logo associated with the project.",
        "operationId": "modifyProjectLogoUsingPut_LegacyDefaultSpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project to change logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/metadata": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get the custom settings metadata from the extensions.",
        "operationId": "getProjectSettingsMetadata_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The custom settings metadata from the extensions.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectSettingsMetadata"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/summary": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a summary of project-specific information.",
        "operationId": "getProjectSummaryInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Summary",
            "schema": {
              "$ref": "#/definitions/GetProjectSummaryInDatabaseResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/summary/v1": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a summary of project-specific information.",
        "operationId": "getProjectSummaryInDatabaseV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Summary",
            "schema": {
              "$ref": "#/definitions/GetProjectSummaryInDatabaseResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/summary": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a summary of project-specific information.",
        "operationId": "getProjectSummaryInGit_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Summary",
            "schema": {
              "$ref": "#/definitions/GetProjectSummaryInGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/summary/v1": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a summary of project-specific information.",
        "operationId": "getProjectSummaryInGitV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Summary",
            "schema": {
              "$ref": "#/definitions/GetProjectSummaryInGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{unusedGitRef}": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a Project by ID or slug.",
        "operationId": "getProjectByIdOrSlug_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to return",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "unusedGitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project.",
            "schema": {
              "$ref": "#/definitions/ProjectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "List all of the projects in the supplied Octopus Deploy Space, from all project groups. The results will be sorted alphabetically by name.",
        "operationId": "getProjectsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "clonedFromProjectId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "(Obsolete) A partial or complete name to limit the set of retrieved Projects to. This will perform a \"contains\" style match against the supplied name or name-fragment. Left for backwards compatibility.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Projects to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List all of the projects in the supplied Octopus Deploy Space, from all project groups. The results will be sorted alphabetically by name.",
            "schema": {
              "$ref": "#/definitions/ProjectResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Create a new project.",
        "operationId": "createProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProjectCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProjectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/all": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "List all of the projects in the supplied Octopus Deploy Space.",
        "operationId": "getAllProjectsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Project Ids of Projects to filter results to",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "All of the project resources in the supplied Octopus Deploy Space.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{id}/logo": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get the logo associated with the project.",
        "operationId": "getProjectLogoBySpace",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the resource",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectIdOrSlug}/badge/{environmentIdOrSlug}/latest_release": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get Project Badge based on relevant parameters",
        "operationId": "getProjectBadgeImageBySpace",
        "produces": [
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectIdOrSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentIdOrSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeFailed",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "label",
            "type": "string"
          },
          {
            "in": "query",
            "name": "style",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectIdOrSlug}/badge/{environmentIdOrSlug}/latest_release.json": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get Project Badge based on relevant parameters",
        "operationId": "getProjectBadgeJsonBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectIdOrSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentIdOrSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeFailed",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Get Project Badge JSON data",
            "schema": {
              "$ref": "#/definitions/GetProjectBadgeJsonResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a Project by ID or slug.",
        "operationId": "getProjectByIdOrSlugBySpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to return",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project.",
            "schema": {
              "$ref": "#/definitions/ProjectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Projects"
        ],
        "summary": "Modify an existing Project",
        "operationId": "modifyProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project to modify",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that the Project has been modified, containing the updated Project",
            "schema": {
              "$ref": "#/definitions/ProjectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Projects"
        ],
        "summary": "Delete an existing Project",
        "operationId": "deleteProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/git/connectivity-test": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Test the Git settings to make sure we can connect.",
        "operationId": "testGitSettingsBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/TestGitSettingsCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The results from testing git settings.",
            "schema": {
              "$ref": "#/definitions/TestGitSettingsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/git/convert": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Convert an existing project to store its configuration in version control.",
        "operationId": "convertProjectToVersionControlledBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ConvertProjectToVersionControlledCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Empty response indicating the Project was converted",
            "schema": {
              "$ref": "#/definitions/ConvertProjectToVersionControlledResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/git/migrate-runbooks": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Convert all Runbooks to be stored in Git rather than the database.",
        "operationId": "convertProjectRunbooksToGitBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ConvertProjectRunbooksToGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Indicates that the project runbooks were converted to Git",
            "schema": {
              "$ref": "#/definitions/ConvertProjectRunbooksToGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Retrieve a list of Runbooks that will be converted to Git, along with how many RunbookRun History records will be updated.",
        "operationId": "convertRunbookToGitSummaryBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns as summary of the runbooks that will be converted to Git",
            "schema": {
              "$ref": "#/definitions/ConvertRunbookToGitSummaryResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/git/validate": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Validate the provided git ref",
        "operationId": "validateGitRefBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ValidateGitRefCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Validated Git ref or error message",
            "schema": {
              "$ref": "#/definitions/ValidateGitRefResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        },
        "deprecated": true
      }
    },
    "/{spaceId}/projects/{projectId}/logo": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Update the logo associated with the project.",
        "operationId": "modifyProjectLogoBySpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project to change logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Projects"
        ],
        "summary": "Update the logo associated with the project.",
        "operationId": "modifyProjectLogoBySpaceUsingPut",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project to change logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/metadata": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get the custom settings metadata from the extensions.",
        "operationId": "getProjectSettingsMetadataBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The custom settings metadata from the extensions.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectSettingsMetadata"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/summary": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a summary of project-specific information.",
        "operationId": "getProjectSummaryInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Summary",
            "schema": {
              "$ref": "#/definitions/GetProjectSummaryInDatabaseResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/summary/v1": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a summary of project-specific information.",
        "operationId": "getProjectSummaryInDatabaseV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Summary",
            "schema": {
              "$ref": "#/definitions/GetProjectSummaryInDatabaseResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/summary": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a summary of project-specific information.",
        "operationId": "getProjectSummaryInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Summary",
            "schema": {
              "$ref": "#/definitions/GetProjectSummaryInGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/summary/v1": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a summary of project-specific information.",
        "operationId": "getProjectSummaryInGitV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Summary",
            "schema": {
              "$ref": "#/definitions/GetProjectSummaryInGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{unusedGitRef}": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a Project by ID or slug.",
        "operationId": "getProjectByIdOrSlugBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to return",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "unusedGitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project.",
            "schema": {
              "$ref": "#/definitions/ProjectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "List all of the projects in the supplied Octopus Deploy Space, from all project groups. The results will be sorted alphabetically by name.",
        "operationId": "getProjects",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "clonedFromProjectId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "(Obsolete) A partial or complete name to limit the set of retrieved Projects to. This will perform a \"contains\" style match against the supplied name or name-fragment. Left for backwards compatibility.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Projects to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List all of the projects in the supplied Octopus Deploy Space, from all project groups. The results will be sorted alphabetically by name.",
            "schema": {
              "$ref": "#/definitions/ProjectResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Create a new project.",
        "operationId": "createProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProjectCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProjectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/all": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "List all of the projects in the supplied Octopus Deploy Space.",
        "operationId": "getAllProjects",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Project Ids of Projects to filter results to",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "All of the project resources in the supplied Octopus Deploy Space.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{id}/logo": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get the logo associated with the project.",
        "operationId": "getProjectLogo",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the resource",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectIdOrSlug}/badge/{environmentIdOrSlug}/latest_release": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get Project Badge based on relevant parameters",
        "operationId": "getProjectBadgeImage",
        "produces": [
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectIdOrSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentIdOrSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeFailed",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "label",
            "type": "string"
          },
          {
            "in": "query",
            "name": "style",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectIdOrSlug}/badge/{environmentIdOrSlug}/latest_release.json": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get Project Badge based on relevant parameters",
        "operationId": "getProjectBadgeJson",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectIdOrSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentIdOrSlug",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeFailed",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenantId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Get Project Badge JSON data",
            "schema": {
              "$ref": "#/definitions/GetProjectBadgeJsonResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a Project by ID or slug.",
        "operationId": "getProjectByIdOrSlug_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to return",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project.",
            "schema": {
              "$ref": "#/definitions/ProjectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Projects"
        ],
        "summary": "Modify an existing Project",
        "operationId": "modifyProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project to modify",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that the Project has been modified, containing the updated Project",
            "schema": {
              "$ref": "#/definitions/ProjectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Projects"
        ],
        "summary": "Delete an existing Project",
        "operationId": "deleteProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/git/connectivity-test": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Test the Git settings to make sure we can connect.",
        "operationId": "testGitSettings",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/TestGitSettingsCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The results from testing git settings.",
            "schema": {
              "$ref": "#/definitions/TestGitSettingsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/git/convert": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Convert an existing project to store its configuration in version control.",
        "operationId": "convertProjectToVersionControlled",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ConvertProjectToVersionControlledCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Empty response indicating the Project was converted",
            "schema": {
              "$ref": "#/definitions/ConvertProjectToVersionControlledResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/git/migrate-runbooks": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Convert all Runbooks to be stored in Git rather than the database.",
        "operationId": "convertProjectRunbooksToGit",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ConvertProjectRunbooksToGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Indicates that the project runbooks were converted to Git",
            "schema": {
              "$ref": "#/definitions/ConvertProjectRunbooksToGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Retrieve a list of Runbooks that will be converted to Git, along with how many RunbookRun History records will be updated.",
        "operationId": "convertRunbookToGitSummary",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns as summary of the runbooks that will be converted to Git",
            "schema": {
              "$ref": "#/definitions/ConvertRunbookToGitSummaryResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/git/validate": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Validate the provided git ref",
        "operationId": "validateGitRef",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ValidateGitRefCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Validated Git ref or error message",
            "schema": {
              "$ref": "#/definitions/ValidateGitRefResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        },
        "deprecated": true
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/logo": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Update the logo associated with the project.",
        "operationId": "modifyProjectLogo",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project to change logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Projects"
        ],
        "summary": "Update the logo associated with the project.",
        "operationId": "modifyProjectLogoUsingPut",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project to change logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/metadata": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get the custom settings metadata from the extensions.",
        "operationId": "getProjectSettingsMetadata",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The custom settings metadata from the extensions.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectSettingsMetadata"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/summary": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a summary of project-specific information.",
        "operationId": "getProjectSummaryInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Summary",
            "schema": {
              "$ref": "#/definitions/GetProjectSummaryInDatabaseResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/summary/v1": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a summary of project-specific information.",
        "operationId": "getProjectSummaryInDatabaseV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Summary",
            "schema": {
              "$ref": "#/definitions/GetProjectSummaryInDatabaseResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/summary": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a summary of project-specific information.",
        "operationId": "getProjectSummaryInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Summary",
            "schema": {
              "$ref": "#/definitions/GetProjectSummaryInGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/summary/v1": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a summary of project-specific information.",
        "operationId": "getProjectSummaryInGitV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Summary",
            "schema": {
              "$ref": "#/definitions/GetProjectSummaryInGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{unusedGitRef}": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get a Project by ID or slug.",
        "operationId": "getProjectByIdOrSlug",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to return",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "unusedGitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project.",
            "schema": {
              "$ref": "#/definitions/ProjectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/platformhub/{gitRef}/projecttemplates/{slug}/share": {
      "post": {
        "tags": [
          "ProjectTemplates"
        ],
        "summary": "Share a project template to spaces",
        "operationId": "shareProjectTemplateByGitRef",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ShareProjectTemplateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Response containing the results of the share project template command",
            "schema": {
              "$ref": "#/definitions/ShareProjectTemplateResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/triggers": {
      "get": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Get Project Triggers within a given Project",
        "operationId": "getProjectTriggersForProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to get Project Triggers for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbooks",
            "description": "A list of Runbook IDs, to limit the matching of Project Triggers to those with a particular Runbook ID. Example: [\"Runbooks-1\", \"Runbooks-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbookTags",
            "description": "A list of Runbook Tags to filter tag based triggers. Tag based triggers matching any of these tags will be included.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "triggerActionCategory",
            "description": "Filters the Project Triggers using the specified Trigger Action Category",
            "type": "string",
            "enum": [
              "Deployment",
              "Runbook"
            ]
          },
          {
            "in": "query",
            "name": "triggerActionType",
            "description": "Filters the Project Triggers using the specified Trigger Action Type",
            "type": "string",
            "enum": [
              "AutoDeploy",
              "DeployLatestRelease",
              "DeployNewRelease",
              "DeployLatestReleaseToEnvironment",
              "RunRunbook",
              "CreateRelease"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Project Triggers",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Create a new project trigger",
        "operationId": "createProjectTrigger_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "Id of the project to create a trigger in",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProjectTriggerCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/triggers/{id}": {
      "get": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Get project trigger by project id and trigger id",
        "operationId": "getProjectTriggerByProjectIdAndTriggerId_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "Id of the project that trigger is in",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Project Trigger to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Trigger",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Modify a ProjectTriggerResource by ID",
        "description": "Updates an existing project trigger",
        "operationId": "modifyProjectTrigger_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ProjectId of the project trigger",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the project trigger",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectTriggerCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Modified project trigger resource response",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Delete an existing Project Trigger",
        "operationId": "deleteProjectTrigger_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "Id of the project to create a trigger in",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the project trigger to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Project Trigger was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteProjectTriggerResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projecttriggers": {
      "get": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Get a list of Project Triggers.",
        "description": "Gets all the Project Triggers in the supplied Octopus Deploy Space, sorted by Id",
        "operationId": "getProjectTriggers_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "runbooks",
            "description": "A list of Runbook IDs, to limit the matching of Project Triggers to those with a particular Runbook ID. Example: [\"Runbooks-1\", \"Runbooks-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Project Triggers",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Create a new project trigger",
        "operationId": "createProjectTrigger_LegacyInferProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProjectTriggerCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projecttriggers/{id}": {
      "get": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Get a Project Trigger by ID",
        "operationId": "getProjectTriggerById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Project Trigger to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Trigger",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Modify a ProjectTriggerResource by ID",
        "description": "Updates an existing project trigger",
        "operationId": "modifyProjectTrigger_LegacyInferProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the project trigger",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectTriggerCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Modified project trigger resource response",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Delete an existing Project Trigger",
        "operationId": "deleteProjectTrigger_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the project trigger to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Project Trigger was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteProjectTriggerResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/triggers": {
      "get": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Get Project Triggers within a given Project",
        "operationId": "getProjectTriggersForProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to get Project Triggers for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbooks",
            "description": "A list of Runbook IDs, to limit the matching of Project Triggers to those with a particular Runbook ID. Example: [\"Runbooks-1\", \"Runbooks-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbookTags",
            "description": "A list of Runbook Tags to filter tag based triggers. Tag based triggers matching any of these tags will be included.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "triggerActionCategory",
            "description": "Filters the Project Triggers using the specified Trigger Action Category",
            "type": "string",
            "enum": [
              "Deployment",
              "Runbook"
            ]
          },
          {
            "in": "query",
            "name": "triggerActionType",
            "description": "Filters the Project Triggers using the specified Trigger Action Type",
            "type": "string",
            "enum": [
              "AutoDeploy",
              "DeployLatestRelease",
              "DeployNewRelease",
              "DeployLatestReleaseToEnvironment",
              "RunRunbook",
              "CreateRelease"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Project Triggers",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Create a new project trigger",
        "operationId": "createProjectTriggerBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "Id of the space where the project is located",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "Id of the project to create a trigger in",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProjectTriggerCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/triggers/{id}": {
      "get": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Get project trigger by project id and trigger id",
        "operationId": "getProjectTriggerByProjectIdAndTriggerIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "Id of the space where the project is located",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "Id of the project that trigger is in",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Project Trigger to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Trigger",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Modify a ProjectTriggerResource by ID",
        "description": "Updates an existing project trigger",
        "operationId": "modifyProjectTriggerBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "Id of the space where the project is located",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ProjectId of the project trigger",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the project trigger",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectTriggerCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Modified project trigger resource response",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Delete an existing Project Trigger",
        "operationId": "deleteProjectTriggerBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "Id of the space where the project is located",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "Id of the project to create a trigger in",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the project trigger to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Project Trigger was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteProjectTriggerResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projecttriggers": {
      "get": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Get a list of Project Triggers.",
        "description": "Gets all the Project Triggers in the supplied Octopus Deploy Space, sorted by Id",
        "operationId": "getProjectTriggersBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbooks",
            "description": "A list of Runbook IDs, to limit the matching of Project Triggers to those with a particular Runbook ID. Example: [\"Runbooks-1\", \"Runbooks-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Project Triggers",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Create a new project trigger",
        "operationId": "createProjectTrigger_LegacyInferProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "Id of the space where the project is located",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProjectTriggerCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projecttriggers/{id}": {
      "get": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Get a Project Trigger by ID",
        "operationId": "getProjectTriggerByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "Id of the space where the project is located",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Project Trigger to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Trigger",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Modify a ProjectTriggerResource by ID",
        "description": "Updates an existing project trigger",
        "operationId": "modifyProjectTrigger_LegacyInferProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "Id of the space where the project is located",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the project trigger",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectTriggerCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Modified project trigger resource response",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Delete an existing Project Trigger",
        "operationId": "deleteProjectTrigger_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "Id of the space where the project is located",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the project trigger to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Project Trigger was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteProjectTriggerResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/triggers": {
      "get": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Get Project Triggers within a given Project",
        "operationId": "getProjectTriggersForProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to get Project Triggers for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbooks",
            "description": "A list of Runbook IDs, to limit the matching of Project Triggers to those with a particular Runbook ID. Example: [\"Runbooks-1\", \"Runbooks-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbookTags",
            "description": "A list of Runbook Tags to filter tag based triggers. Tag based triggers matching any of these tags will be included.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "triggerActionCategory",
            "description": "Filters the Project Triggers using the specified Trigger Action Category",
            "type": "string",
            "enum": [
              "Deployment",
              "Runbook"
            ]
          },
          {
            "in": "query",
            "name": "triggerActionType",
            "description": "Filters the Project Triggers using the specified Trigger Action Type",
            "type": "string",
            "enum": [
              "AutoDeploy",
              "DeployLatestRelease",
              "DeployNewRelease",
              "DeployLatestReleaseToEnvironment",
              "RunRunbook",
              "CreateRelease"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Project Triggers",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Create a new project trigger",
        "operationId": "createProjectTrigger",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "Id of the project to create a trigger in",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProjectTriggerCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/triggers/{id}": {
      "get": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Get project trigger by project id and trigger id",
        "operationId": "getProjectTriggerByProjectIdAndTriggerId",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "Id of the project that trigger is in",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Project Trigger to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Trigger",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Modify a ProjectTriggerResource by ID",
        "description": "Updates an existing project trigger",
        "operationId": "modifyProjectTrigger",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ProjectId of the project trigger",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the project trigger",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectTriggerCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Modified project trigger resource response",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Delete an existing Project Trigger",
        "operationId": "deleteProjectTrigger",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "Id of the project to create a trigger in",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the project trigger to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Project Trigger was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteProjectTriggerResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projecttriggers": {
      "get": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Get a list of Project Triggers.",
        "description": "Gets all the Project Triggers in the supplied Octopus Deploy Space, sorted by Id",
        "operationId": "getProjectTriggers",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbooks",
            "description": "A list of Runbook IDs, to limit the matching of Project Triggers to those with a particular Runbook ID. Example: [\"Runbooks-1\", \"Runbooks-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Project Triggers",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Create a new project trigger",
        "operationId": "createProjectTrigger_LegacyInferProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProjectTriggerCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projecttriggers/{id}": {
      "get": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Get a Project Trigger by ID",
        "operationId": "getProjectTriggerById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Project Trigger to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Trigger",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Modify a ProjectTriggerResource by ID",
        "description": "Updates an existing project trigger",
        "operationId": "modifyProjectTrigger_LegacyInferProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the project trigger",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectTriggerCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Modified project trigger resource response",
            "schema": {
              "$ref": "#/definitions/ProjectTriggerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ProjectTriggers"
        ],
        "summary": "Delete an existing Project Trigger",
        "operationId": "deleteProjectTrigger_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the project trigger to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Project Trigger was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteProjectTriggerResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/proxies": {
      "get": {
        "tags": [
          "Proxies"
        ],
        "summary": "Get a list of Proxies",
        "description": "Lists all of the Proxies in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getProxies_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Proxies, sorted alphabetically by name.",
            "schema": {
              "$ref": "#/definitions/ProxyResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Proxies"
        ],
        "summary": "Create a Proxy in the specified Space",
        "operationId": "createProxy_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProxyCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProxyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/proxies/all": {
      "get": {
        "tags": [
          "Proxies"
        ],
        "summary": "Get a list of Proxies",
        "description": "Lists the name and ID of all of the Proxies in the supplied Octopus Deploy Space. The results will be sorted by name.",
        "operationId": "getAllProxies_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The name and ID of all Proxies in the supplied Octopus Deploy Space, sorted by name.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProxyResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/proxies/{id}": {
      "get": {
        "tags": [
          "Proxies"
        ],
        "summary": "Get a Proxy by ID",
        "operationId": "getProxyById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Proxy to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Proxy",
            "schema": {
              "$ref": "#/definitions/ProxyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Proxies"
        ],
        "summary": "Modify the specified Proxy in the specified Space",
        "operationId": "modifyProxy_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Proxy to modify",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProxyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified Proxy",
            "schema": {
              "$ref": "#/definitions/ProxyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Proxies"
        ],
        "summary": "Delete an existing Proxy by Id.",
        "operationId": "deleteProxy_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Proxy to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/proxies": {
      "get": {
        "tags": [
          "Proxies"
        ],
        "summary": "Get a list of Proxies",
        "description": "Lists all of the Proxies in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getProxiesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Proxies, sorted alphabetically by name.",
            "schema": {
              "$ref": "#/definitions/ProxyResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Proxies"
        ],
        "summary": "Create a Proxy in the specified Space",
        "operationId": "createProxyBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProxyCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProxyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/proxies/all": {
      "get": {
        "tags": [
          "Proxies"
        ],
        "summary": "Get a list of Proxies",
        "description": "Lists the name and ID of all of the Proxies in the supplied Octopus Deploy Space. The results will be sorted by name.",
        "operationId": "getAllProxiesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The name and ID of all Proxies in the supplied Octopus Deploy Space, sorted by name.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProxyResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/proxies/{id}": {
      "get": {
        "tags": [
          "Proxies"
        ],
        "summary": "Get a Proxy by ID",
        "operationId": "getProxyByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Proxy to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Proxy",
            "schema": {
              "$ref": "#/definitions/ProxyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Proxies"
        ],
        "summary": "Modify the specified Proxy in the specified Space",
        "operationId": "modifyProxyBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the Space containing the Proxy to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Proxy to modify",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProxyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified Proxy",
            "schema": {
              "$ref": "#/definitions/ProxyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Proxies"
        ],
        "summary": "Delete an existing Proxy by Id.",
        "operationId": "deleteProxyBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Proxy to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/proxies": {
      "get": {
        "tags": [
          "Proxies"
        ],
        "summary": "Get a list of Proxies",
        "description": "Lists all of the Proxies in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getProxies",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Proxies, sorted alphabetically by name.",
            "schema": {
              "$ref": "#/definitions/ProxyResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Proxies"
        ],
        "summary": "Create a Proxy in the specified Space",
        "operationId": "createProxy",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateProxyCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ProxyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/proxies/all": {
      "get": {
        "tags": [
          "Proxies"
        ],
        "summary": "Get a list of Proxies",
        "description": "Lists the name and ID of all of the Proxies in the supplied Octopus Deploy Space. The results will be sorted by name.",
        "operationId": "getAllProxies",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The name and ID of all Proxies in the supplied Octopus Deploy Space, sorted by name.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProxyResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/proxies/{id}": {
      "get": {
        "tags": [
          "Proxies"
        ],
        "summary": "Get a Proxy by ID",
        "operationId": "getProxyById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Proxy to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Proxy",
            "schema": {
              "$ref": "#/definitions/ProxyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Proxies"
        ],
        "summary": "Modify the specified Proxy in the specified Space",
        "operationId": "modifyProxy",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Proxy to modify",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProxyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified Proxy",
            "schema": {
              "$ref": "#/definitions/ProxyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Proxies"
        ],
        "summary": "Delete an existing Proxy by Id.",
        "operationId": "deleteProxy",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Proxy to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/ratelimitingpolicies": {
      "get": {
        "tags": [
          "RateLimiting"
        ],
        "summary": "List all rate limiting policies.",
        "description": "There are three builtin policies, so while this returns a paginated response, there is only ever a single page. - Unauthenticated requests - Authenticated requests - AI Agent requests",
        "operationId": "listRateLimitingPolicies",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip.",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take.",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RateLimitingPolicyResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/ratelimitingpolicies/{id}": {
      "get": {
        "tags": [
          "RateLimiting"
        ],
        "summary": "Get a rate limiting policy by ID.",
        "operationId": "getRateLimitingPolicyById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the rate limiting policy.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A Rate Limiting Policy",
            "schema": {
              "$ref": "#/definitions/RateLimitingPolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RateLimiting"
        ],
        "summary": "Modify an existing rate limiting policy.",
        "operationId": "modifyRateLimitingPolicy",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the policy to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRateLimitingPolicyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A Rate Limiting Policy",
            "schema": {
              "$ref": "#/definitions/RateLimitingPolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/channels/{id}/releases": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "List all of the releases that belong to the given Channel.",
        "description": "Releases will be ordered from most recent to least recent,",
        "operationId": "getReleasesForChannel_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Channel to get Releases for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project to which the given Channel belongs.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByVersion",
            "description": "A partial version, to limit the set of Releases to those with a version that includes the partial version",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List of Releases on the given Channel.",
            "schema": {
              "$ref": "#/definitions/ReleaseResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/channels/{id}/releases": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "List all of the releases that belong to the given Channel.",
        "description": "Releases will be ordered from most recent to least recent,",
        "operationId": "getReleasesForChannel_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to which the given Channel belongs.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Channel to get Releases for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByVersion",
            "description": "A partial version, to limit the set of Releases to those with a version that includes the partial version",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List of Releases on the given Channel.",
            "schema": {
              "$ref": "#/definitions/ReleaseResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/releases": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "List all of the releases that belong to the given Project.",
        "description": "Releases will be ordered from most recent to least recent",
        "operationId": "getReleasesForProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to get Releases for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByVersion",
            "description": "A partial version, to limit the set of Releases to those with a version that includes the partial version.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Releases",
            "schema": {
              "$ref": "#/definitions/ReleaseResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/releases/{id}/variables": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a list of Variable Sets included in the Release's current Variable Snapshot",
        "operationId": "getReleaseVariables_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project the Release is in.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Release to get variables for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Variables",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/VariableSetResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/releases/{version}": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a single release by project ID and version number.",
        "operationId": "getReleaseByProjectAndVersion_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "version",
            "description": "The version of the requested release",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/releases": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a list of Releases for the given Space.",
        "description": "Lists all of the Releases in the supplied Octopus Deploy Space, from all projects. The results will be sorted from most recent to least recent release.",
        "operationId": "getReleases_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Releases for the requested Space.",
            "schema": {
              "$ref": "#/definitions/ReleaseResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Create a Release",
        "operationId": "createRelease_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateReleaseCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/releases/create/v1": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Create a Release",
        "operationId": "createReleaseV1_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateReleaseCommandV1"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateReleaseResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/releases/{id}": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a Release by ID",
        "operationId": "getReleaseById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Release to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Releases"
        ],
        "summary": "Update an existing Release",
        "operationId": "modifyRelease_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Release.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyReleaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Release was modified, containing the updated Release",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Releases"
        ],
        "summary": "Delete an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.",
        "operationId": "deleteReleaseById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Release to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/releases/{id}/deployments/template": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get all of the information necessary for creating or editing a deployment for this release.",
        "operationId": "getReleaseDeploymentTemplate_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Release.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment Template for the release.",
            "schema": {
              "$ref": "#/definitions/DeploymentTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/releases/{releaseId}/defects": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get all defects for a release.",
        "operationId": "getReleaseDefects_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Get all defects for a release.",
            "schema": {
              "$ref": "#/definitions/DefectResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Record defect in a release.",
        "operationId": "createReleaseDefect_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateReleaseDefectCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The defect resource that was recorded against a release",
            "schema": {
              "$ref": "#/definitions/DefectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/releases/{releaseId}/defects/resolve": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Resolve defect in a release.",
        "operationId": "resolveReleaseDefect_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Resolved defect",
            "schema": {
              "$ref": "#/definitions/DefectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/releases/{releaseId}/deployments": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "List all of the Deployments that belong to the given Release.",
        "description": "Deployments will be ordered from most recent to least recent.",
        "operationId": "getReleaseDeployments_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "releaseId",
            "description": "ID of the Release to load.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Deployments for the given Release.",
            "schema": {
              "$ref": "#/definitions/DeploymentResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/releases/{releaseId}/deployments/preview/{environmentId}": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).",
        "operationId": "getReleaseDeploymentPreview_LegacyDefaultSpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "releaseId",
            "description": "ID of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Whether to include Disabled Steps in the preview",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "ID of the tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Deployment Preview",
            "schema": {
              "$ref": "#/definitions/DeploymentPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/releases/{releaseId}/deployments/preview/{environmentId}/{tenantId}": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).",
        "operationId": "getReleaseDeploymentPreview_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "releaseId",
            "description": "ID of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "description": "ID of the tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Whether to include Disabled Steps in the preview",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Deployment Preview",
            "schema": {
              "$ref": "#/definitions/DeploymentPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/releases/{releaseId}/deployments/previews": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Return an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.",
        "operationId": "getReleaseDeploymentPreviews_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "releaseId",
            "description": "ID of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetReleaseDeploymentPreviewsRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested array of Release Deployment Previews",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/DeploymentPreviewResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/releases/{releaseId}/progression": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get all of the information necessary for creating or editing a deployment for this release.",
        "operationId": "getReleaseProgression_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Lifecycle progression information necessary for creating or editing a deployment for a release",
            "schema": {
              "$ref": "#/definitions/LifecycleProgressionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/releases/{releaseId}/release-notes": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Update the release notes on an existing Release.",
        "description": "Only the release notes are changed and everything else about the Release is left alone. Variable expressions in the notes are evaluated before they are stored, so the saved text is the resolved one.",
        "operationId": "updateReleaseNotes_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/UpdateReleaseNotesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the release notes were updated, containing the updated Release",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/releases/{releaseId}/snapshot-variables": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Update the Variable Snapshot for a Release",
        "operationId": "updateReleaseVariablesSnapshot_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "releaseId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/UpdateReleaseVariablesSnapshotCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Variable Snapshot for a Release was updated, containing the updated Release",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/channels/{id}/releases": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "List all of the releases that belong to the given Channel.",
        "description": "Releases will be ordered from most recent to least recent,",
        "operationId": "getReleasesForChannel_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space to which the given Channel belongs.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Channel to get Releases for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project to which the given Channel belongs.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByVersion",
            "description": "A partial version, to limit the set of Releases to those with a version that includes the partial version",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List of Releases on the given Channel.",
            "schema": {
              "$ref": "#/definitions/ReleaseResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/channels/{id}/releases": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "List all of the releases that belong to the given Channel.",
        "description": "Releases will be ordered from most recent to least recent,",
        "operationId": "getReleasesForChannelBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space to which the given Channel belongs.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to which the given Channel belongs.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Channel to get Releases for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByVersion",
            "description": "A partial version, to limit the set of Releases to those with a version that includes the partial version",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List of Releases on the given Channel.",
            "schema": {
              "$ref": "#/definitions/ReleaseResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/releases": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "List all of the releases that belong to the given Project.",
        "description": "Releases will be ordered from most recent to least recent",
        "operationId": "getReleasesForProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space to which the given Project belongs.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to get Releases for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByVersion",
            "description": "A partial version, to limit the set of Releases to those with a version that includes the partial version.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Releases",
            "schema": {
              "$ref": "#/definitions/ReleaseResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/releases/{id}/variables": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a list of Variable Sets included in the Release's current Variable Snapshot",
        "operationId": "getReleaseVariablesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project the Release is in.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Release to get variables for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Variables",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/VariableSetResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/releases/{version}": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a single release by project ID and version number.",
        "operationId": "getReleaseByProjectAndVersionBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "version",
            "description": "The version of the requested release",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a list of Releases for the given Space.",
        "description": "Lists all of the Releases in the supplied Octopus Deploy Space, from all projects. The results will be sorted from most recent to least recent release.",
        "operationId": "getReleasesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space to which the Releases belong.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Releases for the requested Space.",
            "schema": {
              "$ref": "#/definitions/ReleaseResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Create a Release",
        "operationId": "createReleaseBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateReleaseCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases/create/v1": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Create a Release",
        "operationId": "createReleaseV1BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateReleaseCommandV1"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateReleaseResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases/{id}": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a Release by ID",
        "operationId": "getReleaseByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space that owns the Release",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Release to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Releases"
        ],
        "summary": "Update an existing Release",
        "operationId": "modifyReleaseBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Release.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyReleaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Release was modified, containing the updated Release",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Releases"
        ],
        "summary": "Delete an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.",
        "operationId": "deleteReleaseByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Release to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases/{id}/deployments/template": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get all of the information necessary for creating or editing a deployment for this release.",
        "operationId": "getReleaseDeploymentTemplateBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Release.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment Template for the release.",
            "schema": {
              "$ref": "#/definitions/DeploymentTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases/{releaseId}/defects": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get all defects for a release.",
        "operationId": "getReleaseDefectsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Get all defects for a release.",
            "schema": {
              "$ref": "#/definitions/DefectResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Record defect in a release.",
        "operationId": "createReleaseDefectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateReleaseDefectCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The defect resource that was recorded against a release",
            "schema": {
              "$ref": "#/definitions/DefectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases/{releaseId}/defects/resolve": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Resolve defect in a release.",
        "operationId": "resolveReleaseDefectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Resolved defect",
            "schema": {
              "$ref": "#/definitions/DefectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases/{releaseId}/deployments": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "List all of the Deployments that belong to the given Release.",
        "description": "Deployments will be ordered from most recent to least recent.",
        "operationId": "getReleaseDeploymentsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space to which the Release belongs.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "ID of the Release to load.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Deployments for the given Release.",
            "schema": {
              "$ref": "#/definitions/DeploymentResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases/{releaseId}/deployments/preview/{environmentId}": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).",
        "operationId": "getReleaseDeploymentPreviewBySpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the space containing the resources",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "ID of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Whether to include Disabled Steps in the preview",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "ID of the tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Deployment Preview",
            "schema": {
              "$ref": "#/definitions/DeploymentPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases/{releaseId}/deployments/preview/{environmentId}/{tenantId}": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).",
        "operationId": "getReleaseDeploymentPreviewBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the space containing the resources",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "ID of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "description": "ID of the tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Whether to include Disabled Steps in the preview",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Deployment Preview",
            "schema": {
              "$ref": "#/definitions/DeploymentPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases/{releaseId}/deployments/previews": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Return an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.",
        "operationId": "getReleaseDeploymentPreviewsBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the space containing the resources",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "ID of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetReleaseDeploymentPreviewsRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested array of Release Deployment Previews",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/DeploymentPreviewResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases/{releaseId}/missingPackages": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get the list of Packages that are missing from the built-in feed for a release",
        "operationId": "getMissingPackagesForReleaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Packages from the built-in feed missing for a Release.",
            "schema": {
              "$ref": "#/definitions/GetMissingPackagesForReleaseResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases/{releaseId}/progression": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get all of the information necessary for creating or editing a deployment for this release.",
        "operationId": "getReleaseProgressionBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Lifecycle progression information necessary for creating or editing a deployment for a release",
            "schema": {
              "$ref": "#/definitions/LifecycleProgressionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases/{releaseId}/release-notes": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Update the release notes on an existing Release.",
        "description": "Only the release notes are changed and everything else about the Release is left alone. Variable expressions in the notes are evaluated before they are stored, so the saved text is the resolved one.",
        "operationId": "updateReleaseNotesBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/UpdateReleaseNotesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the release notes were updated, containing the updated Release",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/releases/{releaseId}/snapshot-variables": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Update the Variable Snapshot for a Release",
        "operationId": "updateReleaseVariablesSnapshotBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/UpdateReleaseVariablesSnapshotCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Variable Snapshot for a Release was updated, containing the updated Release",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/channels/{id}/releases": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "List all of the releases that belong to the given Channel.",
        "description": "Releases will be ordered from most recent to least recent,",
        "operationId": "getReleasesForChannel_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Channel to get Releases for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project to which the given Channel belongs.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByVersion",
            "description": "A partial version, to limit the set of Releases to those with a version that includes the partial version",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List of Releases on the given Channel.",
            "schema": {
              "$ref": "#/definitions/ReleaseResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/channels/{id}/releases": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "List all of the releases that belong to the given Channel.",
        "description": "Releases will be ordered from most recent to least recent,",
        "operationId": "getReleasesForChannel",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to which the given Channel belongs.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Channel to get Releases for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByVersion",
            "description": "A partial version, to limit the set of Releases to those with a version that includes the partial version",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "List of Releases on the given Channel.",
            "schema": {
              "$ref": "#/definitions/ReleaseResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/releases": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "List all of the releases that belong to the given Project.",
        "description": "Releases will be ordered from most recent to least recent",
        "operationId": "getReleasesForProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to get Releases for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByVersion",
            "description": "A partial version, to limit the set of Releases to those with a version that includes the partial version.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Releases",
            "schema": {
              "$ref": "#/definitions/ReleaseResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/releases/{id}/variables": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a list of Variable Sets included in the Release's current Variable Snapshot",
        "operationId": "getReleaseVariables",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project the Release is in.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Release to get variables for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Variables",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/VariableSetResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/releases/{version}": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a single release by project ID and version number.",
        "operationId": "getReleaseByProjectAndVersion",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "version",
            "description": "The version of the requested release",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a list of Releases for the given Space.",
        "description": "Lists all of the Releases in the supplied Octopus Deploy Space, from all projects. The results will be sorted from most recent to least recent release.",
        "operationId": "getReleases",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Releases for the requested Space.",
            "schema": {
              "$ref": "#/definitions/ReleaseResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Create a Release",
        "operationId": "createRelease",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateReleaseCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases/create/v1": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Create a Release",
        "operationId": "createReleaseV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateReleaseCommandV1"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateReleaseResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases/{id}": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a Release by ID",
        "operationId": "getReleaseById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Release to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Releases"
        ],
        "summary": "Update an existing Release",
        "operationId": "modifyRelease",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Release.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyReleaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Release was modified, containing the updated Release",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Releases"
        ],
        "summary": "Delete an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.",
        "operationId": "deleteReleaseById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Release to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases/{id}/deployments/template": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get all of the information necessary for creating or editing a deployment for this release.",
        "operationId": "getReleaseDeploymentTemplate",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Release.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Deployment Template for the release.",
            "schema": {
              "$ref": "#/definitions/DeploymentTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases/{releaseId}/defects": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get all defects for a release.",
        "operationId": "getReleaseDefects",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Get all defects for a release.",
            "schema": {
              "$ref": "#/definitions/DefectResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Record defect in a release.",
        "operationId": "createReleaseDefect",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateReleaseDefectCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The defect resource that was recorded against a release",
            "schema": {
              "$ref": "#/definitions/DefectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases/{releaseId}/defects/resolve": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Resolve defect in a release.",
        "operationId": "resolveReleaseDefect",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Resolved defect",
            "schema": {
              "$ref": "#/definitions/DefectResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases/{releaseId}/deployments": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "List all of the Deployments that belong to the given Release.",
        "description": "Deployments will be ordered from most recent to least recent.",
        "operationId": "getReleaseDeployments",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "ID of the Release to load.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Deployments for the given Release.",
            "schema": {
              "$ref": "#/definitions/DeploymentResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases/{releaseId}/deployments/preview/{environmentId}": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).",
        "operationId": "getReleaseDeploymentPreview_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "ID of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Whether to include Disabled Steps in the preview",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "ID of the tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Deployment Preview",
            "schema": {
              "$ref": "#/definitions/DeploymentPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases/{releaseId}/deployments/preview/{environmentId}/{tenantId}": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).",
        "operationId": "getReleaseDeploymentPreview",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "ID of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "description": "ID of the tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Whether to include Disabled Steps in the preview",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Release Deployment Preview",
            "schema": {
              "$ref": "#/definitions/DeploymentPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases/{releaseId}/deployments/previews": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Return an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.",
        "operationId": "getReleaseDeploymentPreviews",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "ID of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetReleaseDeploymentPreviewsRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested array of Release Deployment Previews",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/DeploymentPreviewResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases/{releaseId}/missingPackages": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get the list of Packages that are missing from the built-in feed for a release",
        "operationId": "getMissingPackagesForRelease",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Packages from the built-in feed missing for a Release.",
            "schema": {
              "$ref": "#/definitions/GetMissingPackagesForReleaseResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases/{releaseId}/progression": {
      "get": {
        "tags": [
          "Releases"
        ],
        "summary": "Get all of the information necessary for creating or editing a deployment for this release.",
        "operationId": "getReleaseProgression",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Lifecycle progression information necessary for creating or editing a deployment for a release",
            "schema": {
              "$ref": "#/definitions/LifecycleProgressionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases/{releaseId}/release-notes": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Update the release notes on an existing Release.",
        "description": "Only the release notes are changed and everything else about the Release is left alone. Variable expressions in the notes are evaluated before they are stored, so the saved text is the resolved one.",
        "operationId": "updateReleaseNotes",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "description": "Id of the release",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/UpdateReleaseNotesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the release notes were updated, containing the updated Release",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/releases/{releaseId}/snapshot-variables": {
      "post": {
        "tags": [
          "Releases"
        ],
        "summary": "Update the Variable Snapshot for a Release",
        "operationId": "updateReleaseVariablesSnapshot",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "releaseId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/UpdateReleaseVariablesSnapshotCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Variable Snapshot for a Release was updated, containing the updated Release",
            "schema": {
              "$ref": "#/definitions/ReleaseResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/reporting/deployments/xml": {
      "get": {
        "tags": [
          "Reporting"
        ],
        "summary": "Get an XML report of deployments",
        "operationId": "getDeploymentsXmlReport_LegacyDefaultSpace",
        "produces": [
          "text/xml; charset=utf-8",
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "environmentId",
            "description": "An Environment ID, to limit the set of Deployments to deployed to a particular Environment. Example: Environments-1",
            "type": "string"
          },
          {
            "in": "query",
            "name": "fromCompletedTime",
            "description": "A date/time, to limit the set of Deployments to those which completed after a given moment. Example: 2000-01-01T01:23",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "fromStartTime",
            "description": "A date/time, to limit the set of Deployments to those which started after a given moment. Example: 2000-01-01T01:23",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A Project ID, to limit the set of Deployments to those from a particular Project. Example: Projects-1",
            "type": "string"
          },
          {
            "in": "query",
            "name": "toCompletedTime",
            "description": "A date/time, to limit the set of Deployments to those which completed before a given moment. Example: 2000-01-01T01:23",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "toStartTime",
            "description": "A date/time, to limit the set of Deployments to those which started before a given moment. Example: 2000-01-01T01:23",
            "type": "string",
            "format": "date-time"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/reporting/deployments/xml": {
      "get": {
        "tags": [
          "Reporting"
        ],
        "summary": "Get an XML report of deployments",
        "operationId": "getDeploymentsXmlReportBySpace",
        "produces": [
          "text/xml; charset=utf-8",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentId",
            "description": "An Environment ID, to limit the set of Deployments to deployed to a particular Environment. Example: Environments-1",
            "type": "string"
          },
          {
            "in": "query",
            "name": "fromCompletedTime",
            "description": "A date/time, to limit the set of Deployments to those which completed after a given moment. Example: 2000-01-01T01:23",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "fromStartTime",
            "description": "A date/time, to limit the set of Deployments to those which started after a given moment. Example: 2000-01-01T01:23",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A Project ID, to limit the set of Deployments to those from a particular Project. Example: Projects-1",
            "type": "string"
          },
          {
            "in": "query",
            "name": "toCompletedTime",
            "description": "A date/time, to limit the set of Deployments to those which completed before a given moment. Example: 2000-01-01T01:23",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "toStartTime",
            "description": "A date/time, to limit the set of Deployments to those which started before a given moment. Example: 2000-01-01T01:23",
            "type": "string",
            "format": "date-time"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/reporting/deployments/xml": {
      "get": {
        "tags": [
          "Reporting"
        ],
        "summary": "Get an XML report of deployments",
        "operationId": "getDeploymentsXmlReport",
        "produces": [
          "text/xml; charset=utf-8",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentId",
            "description": "An Environment ID, to limit the set of Deployments to deployed to a particular Environment. Example: Environments-1",
            "type": "string"
          },
          {
            "in": "query",
            "name": "fromCompletedTime",
            "description": "A date/time, to limit the set of Deployments to those which completed after a given moment. Example: 2000-01-01T01:23",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "fromStartTime",
            "description": "A date/time, to limit the set of Deployments to those which started after a given moment. Example: 2000-01-01T01:23",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A Project ID, to limit the set of Deployments to those from a particular Project. Example: Projects-1",
            "type": "string"
          },
          {
            "in": "query",
            "name": "toCompletedTime",
            "description": "A date/time, to limit the set of Deployments to those which completed before a given moment. Example: 2000-01-01T01:23",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "toStartTime",
            "description": "A date/time, to limit the set of Deployments to those which started before a given moment. Example: 2000-01-01T01:23",
            "type": "string",
            "format": "date-time"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/configuration/retention-default": {
      "get": {
        "tags": [
          "Retention"
        ],
        "summary": "Get the default retention configuration",
        "operationId": "getRetentionDefaultConfiguration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The default retention configuration",
            "schema": {
              "$ref": "#/definitions/RetentionDefaultConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Retention"
        ],
        "summary": "Update the default retention configuration.",
        "operationId": "modifyRetentionDefaultConfiguration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRetentionDefaultConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/retentionpolicies": {
      "get": {
        "tags": [
          "Retention"
        ],
        "summary": "Get the configured default retention policies for the given retention type",
        "operationId": "getDefaultRetentionPolicyByType_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "retentionType",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the configured default retention policy values",
            "schema": {
              "$ref": "#/definitions/SpaceDefaultRetentionPolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/retentionpolicies/{id}": {
      "put": {
        "tags": [
          "Retention"
        ],
        "summary": "Modify a default retention policy.",
        "operationId": "modifyDefaultRetentionPolicy_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the default retention policy.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDefaultRetentionPolicyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The response returned from the request to modify a default retention policy.",
            "schema": {
              "$ref": "#/definitions/SpaceDefaultRetentionPolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/retentionpolicies": {
      "get": {
        "tags": [
          "Retention"
        ],
        "summary": "Get the configured default retention policies for the given retention type",
        "operationId": "getDefaultRetentionPolicyByTypeBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "retentionType",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the configured default retention policy values",
            "schema": {
              "$ref": "#/definitions/SpaceDefaultRetentionPolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/retentionpolicies/{id}": {
      "put": {
        "tags": [
          "Retention"
        ],
        "summary": "Modify a default retention policy.",
        "operationId": "modifyDefaultRetentionPolicyBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space that contains the default retention policy.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the default retention policy.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDefaultRetentionPolicyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The response returned from the request to modify a default retention policy.",
            "schema": {
              "$ref": "#/definitions/SpaceDefaultRetentionPolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/retentionpolicies": {
      "get": {
        "tags": [
          "Retention"
        ],
        "summary": "Get the configured default retention policies for the given retention type",
        "operationId": "getDefaultRetentionPolicyByType",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "retentionType",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the configured default retention policy values",
            "schema": {
              "$ref": "#/definitions/SpaceDefaultRetentionPolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/retentionpolicies/{id}": {
      "put": {
        "tags": [
          "Retention"
        ],
        "summary": "Modify a default retention policy.",
        "operationId": "modifyDefaultRetentionPolicy",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the default retention policy.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyDefaultRetentionPolicyCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The response returned from the request to modify a default retention policy.",
            "schema": {
              "$ref": "#/definitions/SpaceDefaultRetentionPolicyResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/featuretoggles/rollout-groups": {
      "get": {
        "tags": [
          "RolloutGroups"
        ],
        "summary": "Lists rollout groups within a project.",
        "operationId": "listRolloutGroupsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters results to rollout groups whose name contains this text (case-insensitive substring match).",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RolloutGroupResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RolloutGroups"
        ],
        "summary": "Creates a rollout group within a project.",
        "operationId": "createRolloutGroupBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRolloutGroupCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RolloutGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/featuretoggles/rollout-groups/{id}": {
      "get": {
        "tags": [
          "RolloutGroups"
        ],
        "summary": "Retrieves a rollout group by Id.",
        "operationId": "getRolloutGroupBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A rollout group within a project, used to link rollout percentages between feature toggles.",
            "schema": {
              "$ref": "#/definitions/RolloutGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RolloutGroups"
        ],
        "summary": "Modifies a rollout group.",
        "operationId": "modifyRolloutGroupBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRolloutGroupCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A rollout group within a project, used to link rollout percentages between feature toggles.",
            "schema": {
              "$ref": "#/definitions/RolloutGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "RolloutGroups"
        ],
        "summary": "Deletes a rollout group.",
        "operationId": "deleteRolloutGroupBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response from deleting a rollout group.",
            "schema": {
              "$ref": "#/definitions/DeleteRolloutGroupResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/featuretoggles/rollout-groups": {
      "get": {
        "tags": [
          "RolloutGroups"
        ],
        "summary": "Lists rollout groups within a project.",
        "operationId": "listRolloutGroups",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "Filters results to rollout groups whose name contains this text (case-insensitive substring match).",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RolloutGroupResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RolloutGroups"
        ],
        "summary": "Creates a rollout group within a project.",
        "operationId": "createRolloutGroup",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRolloutGroupCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RolloutGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/featuretoggles/rollout-groups/{id}": {
      "get": {
        "tags": [
          "RolloutGroups"
        ],
        "summary": "Retrieves a rollout group by Id.",
        "operationId": "getRolloutGroup",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "A rollout group within a project, used to link rollout percentages between feature toggles.",
            "schema": {
              "$ref": "#/definitions/RolloutGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RolloutGroups"
        ],
        "summary": "Modifies a rollout group.",
        "operationId": "modifyRolloutGroup",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRolloutGroupCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A rollout group within a project, used to link rollout percentages between feature toggles.",
            "schema": {
              "$ref": "#/definitions/RolloutGroupResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "RolloutGroups"
        ],
        "summary": "Deletes a rollout group.",
        "operationId": "deleteRolloutGroup",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response from deleting a rollout group.",
            "schema": {
              "$ref": "#/definitions/DeleteRolloutGroupResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookProcesses": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get a list of Runbook Processes",
        "operationId": "getRunbookProcessesWithProjectId_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing the Runbook Processes",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Processes",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookProcesses/{id}": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get the runbook process for the given ID",
        "operationId": "getRunbookProcessByIdWithProjectIdInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook process to retrieve.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Modify a Runbook Process.",
        "description": "Only allowed for Runbook Processes owned by a project.",
        "operationId": "modifyRunbookProcessInDatabase_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookProcessInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Process has been modified, containing the updated Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookProcesses/{id}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Snapshot using this Runbook Process",
        "operationId": "getRunbookProcessSnapshotTemplate_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Runbook Process",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Process Snapshot Template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/runbookProcesses/{id}": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get the runbook process for the given ID",
        "operationId": "getRunbookProcessByIdWithProjectIdInGit_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the runbook process belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The Git ref to read the runbook process from.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook process to retrieve.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Modify a Runbook Process.",
        "description": "Only allowed for Runbook Processes owned by a project.",
        "operationId": "modifyRunbookProcessInGit_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The GitRef containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookProcessInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Process has been modified, containing the updated Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbookProcesses": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get a list of Runbook Processes",
        "operationId": "getRunbookProcesses_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Processes",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbookProcesses/{id}": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get the runbook process for the given ID",
        "operationId": "getRunbookProcessById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook process to retrieve.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Modify a Runbook Process.",
        "description": "Only allowed for Runbook Processes owned by a project.",
        "operationId": "modifyRunbookProcessInDatabase_LegacyInferProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookProcessInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Process has been modified, containing the updated Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbookProcesses/{id}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Snapshot using this Runbook Process",
        "operationId": "getRunbookProcessSnapshotTemplate_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Runbook Process",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Process Snapshot Template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookProcesses": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get a list of Runbook Processes",
        "operationId": "getRunbookProcessesWithProjectIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing the Runbook Processes",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Processes",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookProcesses/{id}": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get the runbook process for the given ID",
        "operationId": "getRunbookProcessByIdWithProjectIdInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook process to retrieve.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Modify a Runbook Process.",
        "description": "Only allowed for Runbook Processes owned by a project.",
        "operationId": "modifyRunbookProcessInDatabaseBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookProcessInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Process has been modified, containing the updated Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookProcesses/{id}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Snapshot using this Runbook Process",
        "operationId": "getRunbookProcessSnapshotTemplateBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Runbook Process",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Process Snapshot Template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/runbookProcesses/{id}": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get the runbook process for the given ID",
        "operationId": "getRunbookProcessByIdWithProjectIdInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the runbook process belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The Git ref to read the runbook process from.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook process to retrieve.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Modify a Runbook Process.",
        "description": "Only allowed for Runbook Processes owned by a project.",
        "operationId": "modifyRunbookProcessInGitBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The GitRef containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookProcessInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Process has been modified, containing the updated Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbookProcesses": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get a list of Runbook Processes",
        "operationId": "getRunbookProcessesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Processes",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbookProcesses/{id}": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get the runbook process for the given ID",
        "operationId": "getRunbookProcessByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook process to retrieve.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Modify a Runbook Process.",
        "description": "Only allowed for Runbook Processes owned by a project.",
        "operationId": "modifyRunbookProcessInDatabase_LegacyInferProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookProcessInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Process has been modified, containing the updated Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbookProcesses/{id}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Snapshot using this Runbook Process",
        "operationId": "getRunbookProcessSnapshotTemplate_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Runbook Process",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Process Snapshot Template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookProcesses": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get a list of Runbook Processes",
        "operationId": "getRunbookProcessesWithProjectId",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing the Runbook Processes",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Processes",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookProcesses/{id}": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get the runbook process for the given ID",
        "operationId": "getRunbookProcessByIdWithProjectIdInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook process to retrieve.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Modify a Runbook Process.",
        "description": "Only allowed for Runbook Processes owned by a project.",
        "operationId": "modifyRunbookProcessInDatabase",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookProcessInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Process has been modified, containing the updated Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookProcesses/{id}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Snapshot using this Runbook Process",
        "operationId": "getRunbookProcessSnapshotTemplate",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Runbook Process",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Process Snapshot Template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbookProcesses/{id}": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get the runbook process for the given ID",
        "operationId": "getRunbookProcessByIdWithProjectIdInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the runbook process belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The Git ref to read the runbook process from.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook process to retrieve.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Modify a Runbook Process.",
        "description": "Only allowed for Runbook Processes owned by a project.",
        "operationId": "modifyRunbookProcessInGit",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The GitRef containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookProcessInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Process has been modified, containing the updated Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbookProcesses": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get a list of Runbook Processes",
        "operationId": "getRunbookProcesses",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Processes",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbookProcesses/{id}": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get the runbook process for the given ID",
        "operationId": "getRunbookProcessById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook process to retrieve.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Runbook Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Modify a Runbook Process.",
        "description": "Only allowed for Runbook Processes owned by a project.",
        "operationId": "modifyRunbookProcessInDatabase_LegacyInferProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookProcessInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Process has been modified, containing the updated Process",
            "schema": {
              "$ref": "#/definitions/RunbookProcessResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbookProcesses/{id}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "RunbookProcesses"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Snapshot using this Runbook Process",
        "operationId": "getRunbookProcessSnapshotTemplate_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Runbook Process",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Process Snapshot Template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookRuns": {
      "get": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Get a list of Runbook Runs",
        "description": "Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects, snapshots and environments accessible by the current user. The results will be sorted from most recent to least recent runbookRun.",
        "operationId": "getRunbookRuns_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environments",
            "description": "Environment Ids to filter results to only Runbook Runs with the given Environment Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Runbook Run Ids to filter results to only Runbook Runs with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Runbook Runs to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projects",
            "description": "Project Ids to filter results to only Runbook Runs with the given Project Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbooks",
            "description": "Runbook Ids to filter results to only Runbooks with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "taskState",
            "description": "Task State to filter results to only Deployments with the given Task State",
            "type": "string",
            "enum": [
              "Queued",
              "Executing",
              "Failed",
              "Canceled",
              "TimedOut",
              "Success",
              "Cancelling"
            ]
          },
          {
            "in": "query",
            "name": "tenants",
            "description": "Tenant Ids to filter results to only Runbook Runs with the given Tenant Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Runs",
            "schema": {
              "$ref": "#/definitions/RunbookRunResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new Runbook Run",
        "operationId": "createRunbookRun_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookRunCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookRunResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookRuns/{id}": {
      "get": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Get a Runbook Run by ID",
        "operationId": "getRunbookRunById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to which the Runbook Run belongs",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Run to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run",
            "schema": {
              "$ref": "#/definitions/RunbookRunResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookruns/{id}": {
      "delete": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Delete an existing Runbook Run",
        "operationId": "deleteRunbookRunByProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to which the Runbook Run belongs",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Run to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookruns/{runbookRunId}/retry/v1": {
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new Runbook run based on an existing runbook run",
        "operationId": "retryGitRunbookRunV1_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookRunId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Runbook run that was retried",
            "schema": {
              "$ref": "#/definitions/RetryGitRunbookRunResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/runbooks/{runbookId}/run/v1": {
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new Runbook Run",
        "operationId": "runGitRunbookV1_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RunGitRunbookCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The newly-created Runbook run",
            "schema": {
              "$ref": "#/definitions/RunGitRunbookResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbook-runs/create/v1": {
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new runbook run",
        "operationId": "createRunbookRunV1_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookRunCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Server tasks associated with the newly-created Runbook Run",
            "schema": {
              "$ref": "#/definitions/CreateRunbookRunResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbookRuns": {
      "get": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Get a list of Runbook Runs",
        "description": "Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects, snapshots and environments accessible by the current user. The results will be sorted from most recent to least recent runbookRun.",
        "operationId": "getRunbookRuns_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "environments",
            "description": "Environment Ids to filter results to only Runbook Runs with the given Environment Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Runbook Run Ids to filter results to only Runbook Runs with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Runbook Runs to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projects",
            "description": "Project Ids to filter results to only Runbook Runs with the given Project Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbooks",
            "description": "Runbook Ids to filter results to only Runbooks with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "taskState",
            "description": "Task State to filter results to only Deployments with the given Task State",
            "type": "string",
            "enum": [
              "Queued",
              "Executing",
              "Failed",
              "Canceled",
              "TimedOut",
              "Success",
              "Cancelling"
            ]
          },
          {
            "in": "query",
            "name": "tenants",
            "description": "Tenant Ids to filter results to only Runbook Runs with the given Tenant Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Runs",
            "schema": {
              "$ref": "#/definitions/RunbookRunResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new Runbook Run",
        "operationId": "createRunbookRun_LegacyInferProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookRunCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookRunResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbookRuns/{id}": {
      "get": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Get a Runbook Run by ID",
        "operationId": "getRunbookRunById_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Run to load",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project to which the Runbook Run belongs",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run",
            "schema": {
              "$ref": "#/definitions/RunbookRunResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbookruns/{id}": {
      "delete": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Delete an existing Runbook Run",
        "operationId": "deleteRunbookRun_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Run to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookRuns": {
      "get": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Get a list of Runbook Runs",
        "description": "Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects, snapshots and environments accessible by the current user. The results will be sorted from most recent to least recent runbookRun.",
        "operationId": "getRunbookRunsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environments",
            "description": "Environment Ids to filter results to only Runbook Runs with the given Environment Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Runbook Run Ids to filter results to only Runbook Runs with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Runbook Runs to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projects",
            "description": "Project Ids to filter results to only Runbook Runs with the given Project Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbooks",
            "description": "Runbook Ids to filter results to only Runbooks with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "taskState",
            "description": "Task State to filter results to only Deployments with the given Task State",
            "type": "string",
            "enum": [
              "Queued",
              "Executing",
              "Failed",
              "Canceled",
              "TimedOut",
              "Success",
              "Cancelling"
            ]
          },
          {
            "in": "query",
            "name": "tenants",
            "description": "Tenant Ids to filter results to only Runbook Runs with the given Tenant Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Runs",
            "schema": {
              "$ref": "#/definitions/RunbookRunResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new Runbook Run",
        "operationId": "createRunbookRunBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookRunCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookRunResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookRuns/{id}": {
      "get": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Get a Runbook Run by ID",
        "operationId": "getRunbookRunByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space to which the Runbook Run belongs",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to which the Runbook Run belongs",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Run to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run",
            "schema": {
              "$ref": "#/definitions/RunbookRunResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookruns/{id}": {
      "delete": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Delete an existing Runbook Run",
        "operationId": "deleteRunbookRunByProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space to which the Runbook Run belongs",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to which the Runbook Run belongs",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Run to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookruns/{runbookRunId}/retry/v1": {
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new Runbook run based on an existing runbook run",
        "operationId": "retryGitRunbookRunV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookRunId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Runbook run that was retried",
            "schema": {
              "$ref": "#/definitions/RetryGitRunbookRunResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/runbooks/{runbookId}/run/v1": {
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new Runbook Run",
        "operationId": "runGitRunbookV1BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RunGitRunbookCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The newly-created Runbook run",
            "schema": {
              "$ref": "#/definitions/RunGitRunbookResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbook-runs/create/v1": {
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new runbook run",
        "operationId": "createRunbookRunV1BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookRunCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Server tasks associated with the newly-created Runbook Run",
            "schema": {
              "$ref": "#/definitions/CreateRunbookRunResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbookRuns": {
      "get": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Get a list of Runbook Runs",
        "description": "Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects, snapshots and environments accessible by the current user. The results will be sorted from most recent to least recent runbookRun.",
        "operationId": "getRunbookRuns_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environments",
            "description": "Environment Ids to filter results to only Runbook Runs with the given Environment Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Runbook Run Ids to filter results to only Runbook Runs with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Runbook Runs to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projects",
            "description": "Project Ids to filter results to only Runbook Runs with the given Project Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbooks",
            "description": "Runbook Ids to filter results to only Runbooks with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "taskState",
            "description": "Task State to filter results to only Deployments with the given Task State",
            "type": "string",
            "enum": [
              "Queued",
              "Executing",
              "Failed",
              "Canceled",
              "TimedOut",
              "Success",
              "Cancelling"
            ]
          },
          {
            "in": "query",
            "name": "tenants",
            "description": "Tenant Ids to filter results to only Runbook Runs with the given Tenant Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Runs",
            "schema": {
              "$ref": "#/definitions/RunbookRunResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new Runbook Run",
        "operationId": "createRunbookRun_LegacyInferProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookRunCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookRunResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbookRuns/{id}": {
      "get": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Get a Runbook Run by ID",
        "operationId": "getRunbookRunById_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space to which the Runbook Run belongs",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Run to load",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project to which the Runbook Run belongs",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run",
            "schema": {
              "$ref": "#/definitions/RunbookRunResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbookruns/{id}": {
      "delete": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Delete an existing Runbook Run",
        "operationId": "deleteRunbookRunBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "ID of the Space to which the Runbook Run belongs",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Run to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookRuns": {
      "get": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Get a list of Runbook Runs",
        "description": "Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects, snapshots and environments accessible by the current user. The results will be sorted from most recent to least recent runbookRun.",
        "operationId": "getRunbookRuns",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environments",
            "description": "Environment Ids to filter results to only Runbook Runs with the given Environment Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Runbook Run Ids to filter results to only Runbook Runs with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Runbook Runs to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projects",
            "description": "Project Ids to filter results to only Runbook Runs with the given Project Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbooks",
            "description": "Runbook Ids to filter results to only Runbooks with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "taskState",
            "description": "Task State to filter results to only Deployments with the given Task State",
            "type": "string",
            "enum": [
              "Queued",
              "Executing",
              "Failed",
              "Canceled",
              "TimedOut",
              "Success",
              "Cancelling"
            ]
          },
          {
            "in": "query",
            "name": "tenants",
            "description": "Tenant Ids to filter results to only Runbook Runs with the given Tenant Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Runs",
            "schema": {
              "$ref": "#/definitions/RunbookRunResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new Runbook Run",
        "operationId": "createRunbookRun",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookRunCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookRunResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookRuns/{id}": {
      "get": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Get a Runbook Run by ID",
        "operationId": "getRunbookRunById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to which the Runbook Run belongs",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Run to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run",
            "schema": {
              "$ref": "#/definitions/RunbookRunResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookruns/{id}": {
      "delete": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Delete an existing Runbook Run",
        "operationId": "deleteRunbookRunByProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to which the Runbook Run belongs",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Run to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookruns/{runbookRunId}/retry/v1": {
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new Runbook run based on an existing runbook run",
        "operationId": "retryGitRunbookRunV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookRunId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Runbook run that was retried",
            "schema": {
              "$ref": "#/definitions/RetryGitRunbookRunResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks/{runbookId}/run/v1": {
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new Runbook Run",
        "operationId": "runGitRunbookV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RunGitRunbookCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The newly-created Runbook run",
            "schema": {
              "$ref": "#/definitions/RunGitRunbookResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbook-runs/create/v1": {
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new runbook run",
        "operationId": "createRunbookRunV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookRunCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Server tasks associated with the newly-created Runbook Run",
            "schema": {
              "$ref": "#/definitions/CreateRunbookRunResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbookRuns": {
      "get": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Get a list of Runbook Runs",
        "description": "Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects, snapshots and environments accessible by the current user. The results will be sorted from most recent to least recent runbookRun.",
        "operationId": "getRunbookRuns_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environments",
            "description": "Environment Ids to filter results to only Runbook Runs with the given Environment Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Runbook Run Ids to filter results to only Runbook Runs with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Runbook Runs to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projects",
            "description": "Project Ids to filter results to only Runbook Runs with the given Project Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbooks",
            "description": "Runbook Ids to filter results to only Runbooks with the given Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "taskState",
            "description": "Task State to filter results to only Deployments with the given Task State",
            "type": "string",
            "enum": [
              "Queued",
              "Executing",
              "Failed",
              "Canceled",
              "TimedOut",
              "Success",
              "Cancelling"
            ]
          },
          {
            "in": "query",
            "name": "tenants",
            "description": "Tenant Ids to filter results to only Runbook Runs with the given Tenant Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Runs",
            "schema": {
              "$ref": "#/definitions/RunbookRunResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Create a new Runbook Run",
        "operationId": "createRunbookRun_LegacyInferProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookRunCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookRunResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbookRuns/{id}": {
      "get": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Get a Runbook Run by ID",
        "operationId": "getRunbookRunById_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Run to load",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project to which the Runbook Run belongs",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run",
            "schema": {
              "$ref": "#/definitions/RunbookRunResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbookruns/{id}": {
      "delete": {
        "tags": [
          "RunbookRuns"
        ],
        "summary": "Delete an existing Runbook Run",
        "operationId": "deleteRunbookRun",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Run to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbooks": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a paginated list of the Runbooks that belong to the given Project",
        "operationId": "getRunbooksForProjectInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "excludedRunbookTags",
            "description": "A list of tag IDs to exclude runbooks by. Returns runbooks that have none of the specified tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbookTags",
            "description": "A list of tag IDs to filter runbooks by. Returns runbooks that have any of the specified tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Create a new Runbook or clone an existing Runbook.",
        "operationId": "createOrCloneRunbookInDatabase_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project that contains the Runbook.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateOrCloneRunbookInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbooks/all/v2": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbooks for a Project",
        "operationId": "getAllRunbooksByProjectV2_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Runbook resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Runbooks",
            "schema": {
              "$ref": "#/definitions/GetAllRunbooksByProjectResponseV2"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbooks/{id}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook by ID",
        "operationId": "getRunbookByIdInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to retrieve",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Update an existing Runbook",
        "operationId": "modifyRunbookInDatabase_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the runbook belongs to. Must be a project that stores its runbooks in the Octopus database.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook to update, for example 'Runbooks-123'.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook has been modified, containing the updated Runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Delete an existing Runbook",
        "operationId": "deleteRunbookInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbooks/{id}/environments": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of environments a Runbook can be run within, based on its EnvironmentScope.",
        "operationId": "getRunbookEnvironmentsInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Environments",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbooks/{id}/runbookRuns/preview/{environment}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithoutRequiredTenantInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbooks/{id}/runbookRuns/preview/{environment}/{tenant}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithRequiredTenantInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbooks/{id}/runbookRunTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).",
        "operationId": "getRunbookTemplateInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project the runbook belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbooks/{runbookId}/run": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Run the published version of this Runbook",
        "operationId": "runRunbook_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project that the runbook belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the runbook to run",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RunRunbookCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbooks/{runbookId}/runbookRuns/previews": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbook Run Previews for a Runbook",
        "description": "Gets a list of Runbook Run Previews that describes what steps will/won't be run during a Runbook Run on a given environment and tenant for a Runbook.",
        "operationId": "getRunbookRunPreviewsInDatabase_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetRunbookRunPreviewsInDatabaseRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Run previews",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/RunbookRunPreviewResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbooks/{runbookId}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Snapshot for a Runbook",
        "operationId": "generateRunbookSnapshotTemplateInDatabase_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "Project Id of the project containing the runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that a new Runbook Snapshot Template has been created, containing the template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/runbooks": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a paginated list of the Runbooks that belong to the given Project",
        "operationId": "getRunbooksForProjectInGit_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The GitRef containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "excludedRunbookTags",
            "description": "A list of tag IDs to exclude runbooks by. Returns runbooks that have none of the specified tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbookTags",
            "description": "A list of tag IDs to filter runbooks by. Returns runbooks that have any of the specified tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/runbooks/{id}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook by ID",
        "operationId": "getRunbookByIdInGit_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to retrieve",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Update an existing Runbook",
        "operationId": "modifyRunbookInGit_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the runbook belongs to. Must be a version-controlled project that stores its runbooks in Git.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The Git branch to commit the change to. This must be a branch — a tag or commit cannot be written to — and the branch must not be protected in the project's version control settings. Use get_branches to list the project's branches.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook to update. A runbook stored in Git uses its slug as the ID, which is only unique within its project and Git ref.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook has been modified, containing the updated Runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Delete an existing Runbook",
        "operationId": "deleteRunbookInGit_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The GitRef containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to delete",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/DeleteRunbookInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/runbooks/{id}/environments": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of environments a Runbook can be run within, based on its EnvironmentScope.",
        "operationId": "getRunbookEnvironmentsInGit_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The Git ref to read the runbook from",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Environments",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/runbooks/{id}/runbookRuns/preview/{environment}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithoutRequiredTenantInGit_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/runbooks/{id}/runbookRuns/preview/{environment}/{tenant}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithRequiredTenantInGit_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/runbooks/{id}/runbookRunTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).",
        "operationId": "getRunbookTemplateInGit_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project the runbook belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "Gitref to get the runbook template from",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitRef}/runbooks/{runbookId}/runbookRuns/previews": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbook Run Previews for a Runbook",
        "description": "Gets a list of Runbook Run Previews that describes what steps will/won't be run during a Runbook Run on a given environment and tenant for a Runbook.",
        "operationId": "getRunbookRunPreviewsInGit_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetRunbookRunPreviewsInGitRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Run previews",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/RunbookRunPreviewResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/{gitref}/runbooks/{runbookId}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Snapshot for a Runbook",
        "operationId": "generateRunbookSnapshotTemplateInGit_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "Project Id of the project containing the runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitref",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that a new Runbook Snapshot Template has been created, containing the template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbooks": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbooks",
        "description": "Gets a paginated list of the Runbooks in the supplied Octopus Deploy Space (sorted by name).",
        "operationId": "getRunbooks_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "List of Runbook IDs which if specified, filters the result to only include Runbooks with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the Runbooks in the supplied Octopus Deploy Space (sorted by name).",
            "schema": {
              "$ref": "#/definitions/RunbookResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Create a new Runbook or clone an existing Runbook.",
        "operationId": "createOrCloneRunbookInDatabase_LegacyInferProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateOrCloneRunbookInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbooks/all": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbooks",
        "description": "Lists all of the Runbooks in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllRunbooks_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Runbook resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projectIds",
            "description": "A list of Project ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Runbooks",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/RunbookResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbooks/{id}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook by ID",
        "operationId": "getRunbookByIdInDatabase_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to retrieve",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Update an existing Runbook",
        "operationId": "modifyRunbookInDatabase_LegacyInferProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook to update, for example 'Runbooks-123'.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook has been modified, containing the updated Runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Delete an existing Runbook",
        "operationId": "deleteRunbookInDatabase_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbooks/{id}/environments": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of environments a Runbook can be run within, based on its EnvironmentScope.",
        "operationId": "getRunbookEnvironmentsInDatabase_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Environments",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbooks/{id}/runbookRuns/preview/{environment}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithoutRequiredTenantInDatabase_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbooks/{id}/runbookRuns/preview/{environment}/{tenant}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithRequiredTenantInDatabase_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbooks/{id}/runbookRunTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).",
        "operationId": "getRunbookTemplateInDatabase_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the project the runbook belongs to",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbooks/{runbookId}/run": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Run the published version of this Runbook",
        "operationId": "runRunbook_LegacyInferProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the runbook to run",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RunRunbookCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbooks/{runbookId}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Snapshot for a Runbook",
        "operationId": "generateRunbookSnapshotTemplateInDatabase_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "Project Id of the project containing the runbook",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that a new Runbook Snapshot Template has been created, containing the template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooks": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a paginated list of the Runbooks that belong to the given Project",
        "operationId": "getRunbooksForProjectInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "excludedRunbookTags",
            "description": "A list of tag IDs to exclude runbooks by. Returns runbooks that have none of the specified tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbookTags",
            "description": "A list of tag IDs to filter runbooks by. Returns runbooks that have any of the specified tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Create a new Runbook or clone an existing Runbook.",
        "operationId": "createOrCloneRunbookInDatabaseBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project that contains the Runbook.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateOrCloneRunbookInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooks/all/v2": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbooks for a Project",
        "operationId": "getAllRunbooksByProjectV2BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Runbook resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Runbooks",
            "schema": {
              "$ref": "#/definitions/GetAllRunbooksByProjectResponseV2"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooks/v2": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Create a new Database Runbook",
        "operationId": "createRunbookInDatabaseV2BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookInDatabaseCommandV2"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateRunbookInDatabaseResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooks/{id}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook by ID",
        "operationId": "getRunbookByIdInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to retrieve",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Update an existing Runbook",
        "operationId": "modifyRunbookInDatabaseBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the runbook belongs to. Must be a project that stores its runbooks in the Octopus database.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook to update, for example 'Runbooks-123'.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook has been modified, containing the updated Runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Delete an existing Runbook",
        "operationId": "deleteRunbookInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooks/{id}/environments": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of environments a Runbook can be run within, based on its EnvironmentScope.",
        "operationId": "getRunbookEnvironmentsInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Environments",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooks/{id}/environments/v2": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of environments a Runbook can be run within, based on its EnvironmentScope.",
        "operationId": "getRunbookEnvironmentsInDatabaseV2BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Environments",
            "schema": {
              "$ref": "#/definitions/GetRunbookEnvironmentsInDatabaseResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooks/{id}/runbookRuns/preview/{environment}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithoutRequiredTenantInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooks/{id}/runbookRuns/preview/{environment}/{tenant}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithRequiredTenantInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooks/{id}/runbookRunTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).",
        "operationId": "getRunbookTemplateInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project the runbook belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooks/{runbookId}/run": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Run the published version of this Runbook",
        "operationId": "runRunbookBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project that the runbook belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the runbook to run",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RunRunbookCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooks/{runbookId}/runbookRuns/previews": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbook Run Previews for a Runbook",
        "description": "Gets a list of Runbook Run Previews that describes what steps will/won't be run during a Runbook Run on a given environment and tenant for a Runbook.",
        "operationId": "getRunbookRunPreviewsInDatabaseBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetRunbookRunPreviewsInDatabaseRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Run previews",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/RunbookRunPreviewResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooks/{runbookId}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Snapshot for a Runbook",
        "operationId": "generateRunbookSnapshotTemplateInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "Project Id of the project containing the runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that a new Runbook Snapshot Template has been created, containing the template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/runbooks": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a paginated list of the Runbooks that belong to the given Project",
        "operationId": "getRunbooksForProjectInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The GitRef containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "excludedRunbookTags",
            "description": "A list of tag IDs to exclude runbooks by. Returns runbooks that have none of the specified tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbookTags",
            "description": "A list of tag IDs to filter runbooks by. Returns runbooks that have any of the specified tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/runbooks/v2": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Create a new Git runbook",
        "operationId": "createRunbookInGitV2BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookInGitCommandV2"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateRunbookInGitResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/runbooks/{id}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook by ID",
        "operationId": "getRunbookByIdInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to retrieve",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Update an existing Runbook",
        "operationId": "modifyRunbookInGitBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the runbook belongs to. Must be a version-controlled project that stores its runbooks in Git.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The Git branch to commit the change to. This must be a branch — a tag or commit cannot be written to — and the branch must not be protected in the project's version control settings. Use get_branches to list the project's branches.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook to update. A runbook stored in Git uses its slug as the ID, which is only unique within its project and Git ref.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook has been modified, containing the updated Runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Delete an existing Runbook",
        "operationId": "deleteRunbookInGitBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The GitRef containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to delete",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/DeleteRunbookInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/runbooks/{id}/environments": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of environments a Runbook can be run within, based on its EnvironmentScope.",
        "operationId": "getRunbookEnvironmentsInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The Git ref to read the runbook from",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Environments",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/runbooks/{id}/environments/v2": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of environments a Runbook can be run within, based on its EnvironmentScope.",
        "operationId": "getRunbookEnvironmentsInGitV2BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Environments",
            "schema": {
              "$ref": "#/definitions/GetRunbookEnvironmentsInGitResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/runbooks/{id}/runbookRuns/preview/{environment}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithoutRequiredTenantInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/runbooks/{id}/runbookRuns/preview/{environment}/{tenant}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithRequiredTenantInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/runbooks/{id}/runbookRunTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).",
        "operationId": "getRunbookTemplateInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project the runbook belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "Gitref to get the runbook template from",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/runbooks/{runbookId}/runbookRuns/previews": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbook Run Previews for a Runbook",
        "description": "Gets a list of Runbook Run Previews that describes what steps will/won't be run during a Runbook Run on a given environment and tenant for a Runbook.",
        "operationId": "getRunbookRunPreviewsInGitBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetRunbookRunPreviewsInGitRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Run previews",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/RunbookRunPreviewResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitref}/runbooks/{runbookId}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Snapshot for a Runbook",
        "operationId": "generateRunbookSnapshotTemplateInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "Project Id of the project containing the runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitref",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that a new Runbook Snapshot Template has been created, containing the template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbooks": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbooks",
        "description": "Gets a paginated list of the Runbooks in the supplied Octopus Deploy Space (sorted by name).",
        "operationId": "getRunbooksBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Runbook IDs which if specified, filters the result to only include Runbooks with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the Runbooks in the supplied Octopus Deploy Space (sorted by name).",
            "schema": {
              "$ref": "#/definitions/RunbookResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Create a new Runbook or clone an existing Runbook.",
        "operationId": "createOrCloneRunbookInDatabase_LegacyInferProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateOrCloneRunbookInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbooks/all": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbooks",
        "description": "Lists all of the Runbooks in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllRunbooksBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Runbook resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projectIds",
            "description": "A list of Project ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Runbooks",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/RunbookResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbooks/{id}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook by ID",
        "operationId": "getRunbookByIdInDatabase_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to retrieve",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Update an existing Runbook",
        "operationId": "modifyRunbookInDatabase_LegacyInferProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook to update, for example 'Runbooks-123'.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook has been modified, containing the updated Runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Delete an existing Runbook",
        "operationId": "deleteRunbookInDatabase_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbooks/{id}/environments": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of environments a Runbook can be run within, based on its EnvironmentScope.",
        "operationId": "getRunbookEnvironmentsInDatabase_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Environments",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbooks/{id}/runbookRuns/preview/{environment}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithoutRequiredTenantInDatabase_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbooks/{id}/runbookRuns/preview/{environment}/{tenant}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithRequiredTenantInDatabase_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbooks/{id}/runbookRunTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).",
        "operationId": "getRunbookTemplateInDatabase_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the project the runbook belongs to",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbooks/{runbookId}/run": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Run the published version of this Runbook",
        "operationId": "runRunbook_LegacyInferProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the runbook to run",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RunRunbookCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbooks/{runbookId}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Snapshot for a Runbook",
        "operationId": "generateRunbookSnapshotTemplateInDatabase_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "Project Id of the project containing the runbook",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that a new Runbook Snapshot Template has been created, containing the template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a paginated list of the Runbooks that belong to the given Project",
        "operationId": "getRunbooksForProjectInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "excludedRunbookTags",
            "description": "A list of tag IDs to exclude runbooks by. Returns runbooks that have none of the specified tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbookTags",
            "description": "A list of tag IDs to filter runbooks by. Returns runbooks that have any of the specified tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Create a new Runbook or clone an existing Runbook.",
        "operationId": "createOrCloneRunbookInDatabase",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The Project that contains the Runbook.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateOrCloneRunbookInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/all/v2": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbooks for a Project",
        "operationId": "getAllRunbooksByProjectV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Runbook resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Runbooks",
            "schema": {
              "$ref": "#/definitions/GetAllRunbooksByProjectResponseV2"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/v2": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Create a new Database Runbook",
        "operationId": "createRunbookInDatabaseV2",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookInDatabaseCommandV2"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateRunbookInDatabaseResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook by ID",
        "operationId": "getRunbookByIdInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to retrieve",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Update an existing Runbook",
        "operationId": "modifyRunbookInDatabase",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the runbook belongs to. Must be a project that stores its runbooks in the Octopus database.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook to update, for example 'Runbooks-123'.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook has been modified, containing the updated Runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Delete an existing Runbook",
        "operationId": "deleteRunbookInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}/environments": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of environments a Runbook can be run within, based on its EnvironmentScope.",
        "operationId": "getRunbookEnvironmentsInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Environments",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}/environments/v2": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of environments a Runbook can be run within, based on its EnvironmentScope.",
        "operationId": "getRunbookEnvironmentsInDatabaseV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Environments",
            "schema": {
              "$ref": "#/definitions/GetRunbookEnvironmentsInDatabaseResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}/runbookRuns/preview/{environment}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithoutRequiredTenantInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}/runbookRuns/preview/{environment}/{tenant}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithRequiredTenantInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}/runbookRunTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).",
        "operationId": "getRunbookTemplateInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project the runbook belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{runbookId}/run": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Run the published version of this Runbook",
        "operationId": "runRunbook",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project that the runbook belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the runbook to run",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RunRunbookCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{runbookId}/runbookRuns/previews": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbook Run Previews for a Runbook",
        "description": "Gets a list of Runbook Run Previews that describes what steps will/won't be run during a Runbook Run on a given environment and tenant for a Runbook.",
        "operationId": "getRunbookRunPreviewsInDatabase",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetRunbookRunPreviewsInDatabaseRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Run previews",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/RunbookRunPreviewResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{runbookId}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Snapshot for a Runbook",
        "operationId": "generateRunbookSnapshotTemplateInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "Project Id of the project containing the runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that a new Runbook Snapshot Template has been created, containing the template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a paginated list of the Runbooks that belong to the given Project",
        "operationId": "getRunbooksForProjectInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The GitRef containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "excludedRunbookTags",
            "description": "A list of tag IDs to exclude runbooks by. Returns runbooks that have none of the specified tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbookTags",
            "description": "A list of tag IDs to filter runbooks by. Returns runbooks that have any of the specified tags.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks/v2": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Create a new Git runbook",
        "operationId": "createRunbookInGitV2",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookInGitCommandV2"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateRunbookInGitResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks/{id}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook by ID",
        "operationId": "getRunbookByIdInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to retrieve",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Update an existing Runbook",
        "operationId": "modifyRunbookInGit",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the runbook belongs to. Must be a version-controlled project that stores its runbooks in Git.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The Git branch to commit the change to. This must be a branch — a tag or commit cannot be written to — and the branch must not be protected in the project's version control settings. Use get_branches to list the project's branches.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook to update. A runbook stored in Git uses its slug as the ID, which is only unique within its project and Git ref.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook has been modified, containing the updated Runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Delete an existing Runbook",
        "operationId": "deleteRunbookInGit",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The GitRef containing the resource(s)",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to delete",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/DeleteRunbookInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks/{id}/environments": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of environments a Runbook can be run within, based on its EnvironmentScope.",
        "operationId": "getRunbookEnvironmentsInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "The Git ref to read the runbook from",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Environments",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks/{id}/environments/v2": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of environments a Runbook can be run within, based on its EnvironmentScope.",
        "operationId": "getRunbookEnvironmentsInGitV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Environments",
            "schema": {
              "$ref": "#/definitions/GetRunbookEnvironmentsInGitResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks/{id}/runbookRuns/preview/{environment}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithoutRequiredTenantInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks/{id}/runbookRuns/preview/{environment}/{tenant}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithRequiredTenantInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks/{id}/runbookRunTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).",
        "operationId": "getRunbookTemplateInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project the runbook belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "description": "Gitref to get the runbook template from",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks/{runbookId}/runbookRuns/previews": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbook Run Previews for a Runbook",
        "description": "Gets a list of Runbook Run Previews that describes what steps will/won't be run during a Runbook Run on a given environment and tenant for a Runbook.",
        "operationId": "getRunbookRunPreviewsInGit",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetRunbookRunPreviewsInGitRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Run previews",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/RunbookRunPreviewResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitref}/runbooks/{runbookId}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Snapshot for a Runbook",
        "operationId": "generateRunbookSnapshotTemplateInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "Project Id of the project containing the runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitref",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that a new Runbook Snapshot Template has been created, containing the template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbooks": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbooks",
        "description": "Gets a paginated list of the Runbooks in the supplied Octopus Deploy Space (sorted by name).",
        "operationId": "getRunbooks",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Runbook IDs which if specified, filters the result to only include Runbooks with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the Runbooks in the supplied Octopus Deploy Space (sorted by name).",
            "schema": {
              "$ref": "#/definitions/RunbookResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Create a new Runbook or clone an existing Runbook.",
        "operationId": "createOrCloneRunbookInDatabase_LegacyInferProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateOrCloneRunbookInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbooks/all": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of Runbooks",
        "description": "Lists all of the Runbooks in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllRunbooks",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Runbook resource ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "projectIds",
            "description": "A list of Project ids used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Runbooks",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/RunbookResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbooks/{id}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook by ID",
        "operationId": "getRunbookByIdInDatabase_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to retrieve",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Update an existing Runbook",
        "operationId": "modifyRunbookInDatabase_LegacyInferProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the runbook to update, for example 'Runbooks-123'.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook has been modified, containing the updated Runbook",
            "schema": {
              "$ref": "#/definitions/RunbookResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Delete an existing Runbook",
        "operationId": "deleteRunbookInDatabase_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbooks/{id}/environments": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a list of environments a Runbook can be run within, based on its EnvironmentScope.",
        "operationId": "getRunbookEnvironmentsInDatabase_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Environments",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/EnvironmentResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbooks/{id}/runbookRuns/preview/{environment}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithoutRequiredTenantInDatabase_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbooks/{id}/runbookRuns/preview/{environment}/{tenant}": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook",
        "description": "Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.",
        "operationId": "getRunbookRunPreviewWithRequiredTenantInDatabase_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environment",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbooks/{id}/runbookRunTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).",
        "operationId": "getRunbookTemplateInDatabase_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the project the runbook belongs to",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbooks/{runbookId}/run": {
      "post": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Run the published version of this Runbook",
        "operationId": "runRunbook_LegacyInferProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the runbook to run",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RunRunbookCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbooks/{runbookId}/runbookSnapshotTemplate": {
      "get": {
        "tags": [
          "Runbooks"
        ],
        "summary": "Get all of the information necessary for creating or editing a Snapshot for a Runbook",
        "operationId": "generateRunbookSnapshotTemplateInDatabase_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookId",
            "description": "ID of the Runbook",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "Project Id of the project containing the runbook",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that a new Runbook Snapshot Template has been created, containing the template",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbooks/{id}/runbookSnapshots": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a paginated list of all of the Runbook Snapshots that belong to the given Runbook.",
        "description": "Runbook Snapshots will be ordered from most recent to least recent.",
        "operationId": "getRunbookSnapshotsForRunbook_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the runbook belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the runbook to get runbook Snapshots for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of all of the Runbook Snapshots that belong to the given Runbook.",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookSnapshots": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a paginated list of all of the Runbook Snapshots that belong to the given Project.",
        "description": "Runbook Snapshots will be ordered from most recent to least recent.",
        "operationId": "getRunbookSnapshotsForProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project to get runbook snapshots for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of all of the Runbook Snapshots that belong to the given Project.",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Create a Runbook Snapshot",
        "operationId": "createRunbookSnapshot_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project that owns the runbook to snapshot.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookSnapshotCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookSnapshots/{idOrName}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a single Runbook Snapshot by project ID and name.",
        "operationId": "getRunbookSnapshotForProjectByName_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to get Runbook Snapshot for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "idOrName",
            "description": "ID or Name of the RunbookSnapshot to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookSnapshots/{id}": {
      "put": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Modify a Runbook Snapshot",
        "operationId": "modifyRunbookSnapshot_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project that owns the runbook.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the runbook snapshot to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookSnapshotCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot was modified, containing the updated snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbooksnapshots/{id}": {
      "delete": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Delete an existing Runbook Snapshot",
        "description": "Also deletes all of the Runbook Runs, Tasks and other associated resources belonging to the Runbook Snapshot.",
        "operationId": "deleteRunbookSnapshot_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project that the Runbook Snapshot belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookSnapshots/{id}/runbookRuns": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get the runbook runs for the given snapshot.",
        "operationId": "getRunbookSnapshotRunbookRunsWithProjectId_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the Runbook Runs for the given Runbook Snapshot.",
            "schema": {
              "$ref": "#/definitions/RunbookRunResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook Snapshot",
        "description": "Gets a document that describes what steps will/won't be run during a run to a given environment (and tenant if supplied)",
        "operationId": "getRunbookRunPreviewForRunbookSnapshot_LegacyDefaultSpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run preview",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}/{tenant}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook Snapshot",
        "description": "Gets a document that describes what steps will/won't be run during a run to a given environment (and tenant if supplied)",
        "operationId": "getRunbookRunPreviewForRunbookSnapshot_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run preview",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/template": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Template for a Runbook Snapshot",
        "description": "Gets all of the information necessary for creating or editing a run for this snapshot.",
        "operationId": "getRunbookRunTemplateForRunbookSnapshot_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project the Runbook Snapshot belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookSnapshots/{id}/snapshot-variables": {
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Update the variable snapshots for a Runbook Snapshot",
        "description": "Update the variable snapshots associated with the runbook snapshot to the latest versions. The runbook's process must not have changed since the snapshot was created.",
        "operationId": "refreshRunbookSnapshotVariables_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RefreshRunbookSnapshotVariablesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot Variables were refreshed, containing the updated Snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookSnapshots/{id}/snapshot-variables/v1": {
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Update the variable snapshots for a Runbook Snapshot",
        "description": "Update the variable snapshots associated with the runbook snapshot to the latest versions. The runbook's process must not have changed since the snapshot was created.",
        "operationId": "refreshRunbookSnapshotVariablesV1_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RefreshRunbookSnapshotVariablesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot Variables were refreshed, containing the updated Snapshot",
            "schema": {
              "$ref": "#/definitions/RefreshRunbookSnapshotVariablesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookSnapshots/{id}/variables": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a list of Variable Sets included in the Runbook Snapshot's current Variable Snapshot",
        "operationId": "getRunbookSnapshotVariables_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project the Runbook Snapshot is in.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to get variables for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Snapshot Variables",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/VariableSetResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/projects/{projectId}/runbookSnapshots/{runbookSnapshotId}/runbookRuns/previews": {
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a list of Runbook Run Previews for a Runbook Snapshot",
        "operationId": "getRunbookRunPreviewsForRunbookSnapshot_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookSnapshotId",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetRunbookRunPreviewsForRunbookSnapshotRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A preview for a Runbook run, representing the planned execution.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/RunbookRunPreviewResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbooks/{id}/runbookSnapshots": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a paginated list of all of the Runbook Snapshots that belong to the given Runbook.",
        "description": "Runbook Snapshots will be ordered from most recent to least recent.",
        "operationId": "getRunbookSnapshotsForRunbook_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the runbook to get runbook Snapshots for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "The ID of the project the runbook belongs to.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of all of the Runbook Snapshots that belong to the given Runbook.",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbookSnapshots": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a paginated list of Runbook Snapshots",
        "description": "Gets a paginated list of the runbook snapshots in the supplied Octopus Deploy Space, from all projects. The results will be sorted from most recent to least recent snapshot.",
        "operationId": "getRunbookSnapshots_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the runbook snapshots in the supplied Octopus Deploy Space, from all projects. The results will be sorted from most recent to least recent snapshot.",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Create a Runbook Snapshot",
        "operationId": "createRunbookSnapshot_LegacyInferProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookSnapshotCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbookSnapshots/{id}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Snapshot by ID",
        "operationId": "getRunbookSnapshotById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the RunbookSnapshot to retrieve",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested runbook snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Modify a Runbook Snapshot",
        "operationId": "modifyRunbookSnapshot_LegacyInferProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the runbook snapshot to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookSnapshotCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot was modified, containing the updated snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbooksnapshots/{id}": {
      "delete": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Delete an existing Runbook Snapshot",
        "description": "Also deletes all of the Runbook Runs, Tasks and other associated resources belonging to the Runbook Snapshot.",
        "operationId": "deleteRunbookSnapshot_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbookSnapshots/{id}/runbookRuns": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get the runbook runs for the given snapshot.",
        "operationId": "getRunbookSnapshotRunbookRuns_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the Runbook Runs for the given Runbook Snapshot.",
            "schema": {
              "$ref": "#/definitions/RunbookRunResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook Snapshot",
        "description": "Gets a document that describes what steps will/won't be run during a run to a given environment (and tenant if supplied)",
        "operationId": "getRunbookRunPreviewForRunbookSnapshot_LegacyInferProject_LegacyDefaultSpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run preview",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}/{tenant}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook Snapshot",
        "description": "Gets a document that describes what steps will/won't be run during a run to a given environment (and tenant if supplied)",
        "operationId": "getRunbookRunPreviewForRunbookSnapshot_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run preview",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbookSnapshots/{id}/runbookRuns/template": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Template for a Runbook Snapshot",
        "description": "Gets all of the information necessary for creating or editing a run for this snapshot.",
        "operationId": "getRunbookRunTemplateForRunbookSnapshot_LegacyInferProject_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project the Runbook Snapshot belongs to",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/runbookSnapshots/{id}/snapshot-variables": {
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Update the variable snapshots for a Runbook Snapshot",
        "description": "Update the variable snapshots associated with the runbook snapshot to the latest versions. The runbook's process must not have changed since the snapshot was created.",
        "operationId": "refreshRunbookSnapshotVariables_LegacyInferProject_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RefreshRunbookSnapshotVariablesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot Variables were refreshed, containing the updated Snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookRuns/{id}/details/v1": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get the packages and Git references that were used in a Runbook run",
        "operationId": "getRunbookRunDetailsV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to get Runbook run packages for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook run to load packages for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Packages and Git references that were used in a Runbook run",
            "schema": {
              "$ref": "#/definitions/GetRunbookRunDetailsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooks/{id}/runbookSnapshots": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a paginated list of all of the Runbook Snapshots that belong to the given Runbook.",
        "description": "Runbook Snapshots will be ordered from most recent to least recent.",
        "operationId": "getRunbookSnapshotsForRunbookBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the runbook belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the runbook to get runbook Snapshots for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of all of the Runbook Snapshots that belong to the given Runbook.",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookSnapshots": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a paginated list of all of the Runbook Snapshots that belong to the given Project.",
        "description": "Runbook Snapshots will be ordered from most recent to least recent.",
        "operationId": "getRunbookSnapshotsForProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project to get runbook snapshots for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of all of the Runbook Snapshots that belong to the given Project.",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Create a Runbook Snapshot",
        "operationId": "createRunbookSnapshotBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project that owns the runbook to snapshot.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookSnapshotCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookSnapshots/{idOrName}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a single Runbook Snapshot by project ID and name.",
        "operationId": "getRunbookSnapshotForProjectByNameBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to get Runbook Snapshot for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "idOrName",
            "description": "ID or Name of the RunbookSnapshot to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookSnapshots/{id}": {
      "put": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Modify a Runbook Snapshot",
        "operationId": "modifyRunbookSnapshotBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project that owns the runbook.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the runbook snapshot to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookSnapshotCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot was modified, containing the updated snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbooksnapshots/{id}": {
      "delete": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Delete an existing Runbook Snapshot",
        "description": "Also deletes all of the Runbook Runs, Tasks and other associated resources belonging to the Runbook Snapshot.",
        "operationId": "deleteRunbookSnapshotBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project that the Runbook Snapshot belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get the runbook runs for the given snapshot.",
        "operationId": "getRunbookSnapshotRunbookRunsWithProjectIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the Runbook Runs for the given Runbook Snapshot.",
            "schema": {
              "$ref": "#/definitions/RunbookRunResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook Snapshot",
        "description": "Gets a document that describes what steps will/won't be run during a run to a given environment (and tenant if supplied)",
        "operationId": "getRunbookRunPreviewForRunbookSnapshotBySpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run preview",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}/{tenant}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook Snapshot",
        "description": "Gets a document that describes what steps will/won't be run during a run to a given environment (and tenant if supplied)",
        "operationId": "getRunbookRunPreviewForRunbookSnapshotBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run preview",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/template": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Template for a Runbook Snapshot",
        "description": "Gets all of the information necessary for creating or editing a run for this snapshot.",
        "operationId": "getRunbookRunTemplateForRunbookSnapshotBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project the Runbook Snapshot belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/snapshot-variables": {
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Update the variable snapshots for a Runbook Snapshot",
        "description": "Update the variable snapshots associated with the runbook snapshot to the latest versions. The runbook's process must not have changed since the snapshot was created.",
        "operationId": "refreshRunbookSnapshotVariablesBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RefreshRunbookSnapshotVariablesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot Variables were refreshed, containing the updated Snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/snapshot-variables/v1": {
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Update the variable snapshots for a Runbook Snapshot",
        "description": "Update the variable snapshots associated with the runbook snapshot to the latest versions. The runbook's process must not have changed since the snapshot was created.",
        "operationId": "refreshRunbookSnapshotVariablesV1BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RefreshRunbookSnapshotVariablesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot Variables were refreshed, containing the updated Snapshot",
            "schema": {
              "$ref": "#/definitions/RefreshRunbookSnapshotVariablesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/variables": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a list of Variable Sets included in the Runbook Snapshot's current Variable Snapshot",
        "operationId": "getRunbookSnapshotVariablesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project the Runbook Snapshot is in.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to get variables for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Snapshot Variables",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/VariableSetResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/runbookSnapshots/{runbookSnapshotId}/runbookRuns/previews": {
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a list of Runbook Run Previews for a Runbook Snapshot",
        "operationId": "getRunbookRunPreviewsForRunbookSnapshotBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookSnapshotId",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetRunbookRunPreviewsForRunbookSnapshotRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A preview for a Runbook run, representing the planned execution.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/RunbookRunPreviewResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbooks/{id}/runbookSnapshots": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a paginated list of all of the Runbook Snapshots that belong to the given Runbook.",
        "description": "Runbook Snapshots will be ordered from most recent to least recent.",
        "operationId": "getRunbookSnapshotsForRunbook_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the runbook to get runbook Snapshots for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "The ID of the project the runbook belongs to.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of all of the Runbook Snapshots that belong to the given Runbook.",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbookSnapshots": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a paginated list of Runbook Snapshots",
        "description": "Gets a paginated list of the runbook snapshots in the supplied Octopus Deploy Space, from all projects. The results will be sorted from most recent to least recent snapshot.",
        "operationId": "getRunbookSnapshotsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the runbook snapshots in the supplied Octopus Deploy Space, from all projects. The results will be sorted from most recent to least recent snapshot.",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Create a Runbook Snapshot",
        "operationId": "createRunbookSnapshot_LegacyInferProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookSnapshotCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbookSnapshots/{id}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Snapshot by ID",
        "operationId": "getRunbookSnapshotByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the RunbookSnapshot to retrieve",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested runbook snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Modify a Runbook Snapshot",
        "operationId": "modifyRunbookSnapshot_LegacyInferProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the runbook snapshot to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookSnapshotCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot was modified, containing the updated snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbooksnapshots/{id}": {
      "delete": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Delete an existing Runbook Snapshot",
        "description": "Also deletes all of the Runbook Runs, Tasks and other associated resources belonging to the Runbook Snapshot.",
        "operationId": "deleteRunbookSnapshot_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbookSnapshots/{id}/runbookRuns": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get the runbook runs for the given snapshot.",
        "operationId": "getRunbookSnapshotRunbookRunsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the Runbook Runs for the given Runbook Snapshot.",
            "schema": {
              "$ref": "#/definitions/RunbookRunResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook Snapshot",
        "description": "Gets a document that describes what steps will/won't be run during a run to a given environment (and tenant if supplied)",
        "operationId": "getRunbookRunPreviewForRunbookSnapshot_LegacyInferProjectBySpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run preview",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}/{tenant}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook Snapshot",
        "description": "Gets a document that describes what steps will/won't be run during a run to a given environment (and tenant if supplied)",
        "operationId": "getRunbookRunPreviewForRunbookSnapshot_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run preview",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbookSnapshots/{id}/runbookRuns/template": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Template for a Runbook Snapshot",
        "description": "Gets all of the information necessary for creating or editing a run for this snapshot.",
        "operationId": "getRunbookRunTemplateForRunbookSnapshot_LegacyInferProjectBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project the Runbook Snapshot belongs to",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/runbookSnapshots/{id}/snapshot-variables": {
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Update the variable snapshots for a Runbook Snapshot",
        "description": "Update the variable snapshots associated with the runbook snapshot to the latest versions. The runbook's process must not have changed since the snapshot was created.",
        "operationId": "refreshRunbookSnapshotVariables_LegacyInferProjectBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RefreshRunbookSnapshotVariablesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot Variables were refreshed, containing the updated Snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookRuns/{id}/details/v1": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get the packages and Git references that were used in a Runbook run",
        "operationId": "getRunbookRunDetailsV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to get Runbook run packages for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook run to load packages for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Packages and Git references that were used in a Runbook run",
            "schema": {
              "$ref": "#/definitions/GetRunbookRunDetailsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}/runbookSnapshots": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a paginated list of all of the Runbook Snapshots that belong to the given Runbook.",
        "description": "Runbook Snapshots will be ordered from most recent to least recent.",
        "operationId": "getRunbookSnapshotsForRunbook",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project the runbook belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the runbook to get runbook Snapshots for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of all of the Runbook Snapshots that belong to the given Runbook.",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a paginated list of all of the Runbook Snapshots that belong to the given Project.",
        "description": "Runbook Snapshots will be ordered from most recent to least recent.",
        "operationId": "getRunbookSnapshotsForProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project to get runbook snapshots for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of all of the Runbook Snapshots that belong to the given Project.",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Create a Runbook Snapshot",
        "operationId": "createRunbookSnapshot",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project that owns the runbook to snapshot.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookSnapshotCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{idOrName}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a single Runbook Snapshot by project ID and name.",
        "operationId": "getRunbookSnapshotForProjectByName",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project to get Runbook Snapshot for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "idOrName",
            "description": "ID or Name of the RunbookSnapshot to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}": {
      "put": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Modify a Runbook Snapshot",
        "operationId": "modifyRunbookSnapshot",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the project that owns the runbook.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the runbook snapshot to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookSnapshotCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot was modified, containing the updated snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbooksnapshots/{id}": {
      "delete": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Delete an existing Runbook Snapshot",
        "description": "Also deletes all of the Runbook Runs, Tasks and other associated resources belonging to the Runbook Snapshot.",
        "operationId": "deleteRunbookSnapshot",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project that the Runbook Snapshot belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get the runbook runs for the given snapshot.",
        "operationId": "getRunbookSnapshotRunbookRunsWithProjectId",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the Runbook Runs for the given Runbook Snapshot.",
            "schema": {
              "$ref": "#/definitions/RunbookRunResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook Snapshot",
        "description": "Gets a document that describes what steps will/won't be run during a run to a given environment (and tenant if supplied)",
        "operationId": "getRunbookRunPreviewForRunbookSnapshot_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run preview",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}/{tenant}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook Snapshot",
        "description": "Gets a document that describes what steps will/won't be run during a run to a given environment (and tenant if supplied)",
        "operationId": "getRunbookRunPreviewForRunbookSnapshot",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run preview",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/template": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Template for a Runbook Snapshot",
        "description": "Gets all of the information necessary for creating or editing a run for this snapshot.",
        "operationId": "getRunbookRunTemplateForRunbookSnapshot",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project the Runbook Snapshot belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/snapshot-variables": {
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Update the variable snapshots for a Runbook Snapshot",
        "description": "Update the variable snapshots associated with the runbook snapshot to the latest versions. The runbook's process must not have changed since the snapshot was created.",
        "operationId": "refreshRunbookSnapshotVariables",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RefreshRunbookSnapshotVariablesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot Variables were refreshed, containing the updated Snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/snapshot-variables/v1": {
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Update the variable snapshots for a Runbook Snapshot",
        "description": "Update the variable snapshots associated with the runbook snapshot to the latest versions. The runbook's process must not have changed since the snapshot was created.",
        "operationId": "refreshRunbookSnapshotVariablesV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "The ID of the project containing this resource. Will be inferred if not provided.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RefreshRunbookSnapshotVariablesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot Variables were refreshed, containing the updated Snapshot",
            "schema": {
              "$ref": "#/definitions/RefreshRunbookSnapshotVariablesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/variables": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a list of Variable Sets included in the Runbook Snapshot's current Variable Snapshot",
        "operationId": "getRunbookSnapshotVariables",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project the Runbook Snapshot is in.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to get variables for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Runbook Snapshot Variables",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/VariableSetResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{runbookSnapshotId}/runbookRuns/previews": {
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a list of Runbook Run Previews for a Runbook Snapshot",
        "operationId": "getRunbookRunPreviewsForRunbookSnapshot",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "runbookSnapshotId",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetRunbookRunPreviewsForRunbookSnapshotRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A preview for a Runbook run, representing the planned execution.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/RunbookRunPreviewResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbooks/{id}/runbookSnapshots": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a paginated list of all of the Runbook Snapshots that belong to the given Runbook.",
        "description": "Runbook Snapshots will be ordered from most recent to least recent.",
        "operationId": "getRunbookSnapshotsForRunbook_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the runbook to get runbook Snapshots for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "The ID of the project the runbook belongs to.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "searchByName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of all of the Runbook Snapshots that belong to the given Runbook.",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbookSnapshots": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a paginated list of Runbook Snapshots",
        "description": "Gets a paginated list of the runbook snapshots in the supplied Octopus Deploy Space, from all projects. The results will be sorted from most recent to least recent snapshot.",
        "operationId": "getRunbookSnapshots",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of the runbook snapshots in the supplied Octopus Deploy Space, from all projects. The results will be sorted from most recent to least recent snapshot.",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Create a Runbook Snapshot",
        "operationId": "createRunbookSnapshot_LegacyInferProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateRunbookSnapshotCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbookSnapshots/{id}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Snapshot by ID",
        "operationId": "getRunbookSnapshotById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the RunbookSnapshot to retrieve",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested runbook snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Modify a Runbook Snapshot",
        "operationId": "modifyRunbookSnapshot_LegacyInferProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the runbook snapshot to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyRunbookSnapshotCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot was modified, containing the updated snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbooksnapshots/{id}": {
      "delete": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Delete an existing Runbook Snapshot",
        "description": "Also deletes all of the Runbook Runs, Tasks and other associated resources belonging to the Runbook Snapshot.",
        "operationId": "deleteRunbookSnapshot_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbookSnapshots/{id}/runbookRuns": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get the runbook runs for the given snapshot.",
        "operationId": "getRunbookSnapshotRunbookRuns",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Contains the Runbook Runs for the given Runbook Snapshot.",
            "schema": {
              "$ref": "#/definitions/RunbookRunResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook Snapshot",
        "description": "Gets a document that describes what steps will/won't be run during a run to a given environment (and tenant if supplied)",
        "operationId": "getRunbookRunPreviewForRunbookSnapshot_LegacyInferProject_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run preview",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}/{tenant}": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Preview for a Runbook Snapshot",
        "description": "Gets a document that describes what steps will/won't be run during a run to a given environment (and tenant if supplied)",
        "operationId": "getRunbookRunPreviewForRunbookSnapshot_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "environmentId",
            "description": "ID of the Environment",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenant",
            "description": "ID of the Tenant",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDisabledSteps",
            "description": "Boolean to include/exclude disabled steps from response",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run preview",
            "schema": {
              "$ref": "#/definitions/RunbookRunPreviewResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbookSnapshots/{id}/runbookRuns/template": {
      "get": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Get a Runbook Run Template for a Runbook Snapshot",
        "description": "Gets all of the information necessary for creating or editing a run for this snapshot.",
        "operationId": "getRunbookRunTemplateForRunbookSnapshot_LegacyInferProject",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot to get a Runbook Run Template for",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of the Project the Runbook Snapshot belongs to",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Runbook Run Template",
            "schema": {
              "$ref": "#/definitions/RunbookRunTemplateResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/runbookSnapshots/{id}/snapshot-variables": {
      "post": {
        "tags": [
          "RunbookSnapshots"
        ],
        "summary": "Update the variable snapshots for a Runbook Snapshot",
        "description": "Update the variable snapshots associated with the runbook snapshot to the latest versions. The runbook's process must not have changed since the snapshot was created.",
        "operationId": "refreshRunbookSnapshotVariables_LegacyInferProject",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Runbook Snapshot",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RefreshRunbookSnapshotVariablesCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Runbook Snapshot Variables were refreshed, containing the updated Snapshot",
            "schema": {
              "$ref": "#/definitions/RunbookSnapshotResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/scheduler": {
      "get": {
        "tags": [
          "ScheduledJobs"
        ],
        "summary": "Get the status of all the scheduled jobs",
        "operationId": "getScheduledJobsStatus",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The Status of all the scheduled jobs",
            "schema": {
              "$ref": "#/definitions/SchedulerStatusResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/scheduler/start": {
      "get": {
        "tags": [
          "ScheduledJobs"
        ],
        "summary": "Enable a scheduled job or the job scheduler",
        "operationId": "enableScheduledJob",
        "produces": [
          "text/plain",
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "task",
            "description": "The name of the Job to enable. If null the job scheduler itself will be enabled.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/scheduler/stop": {
      "get": {
        "tags": [
          "ScheduledJobs"
        ],
        "summary": "Disable a scheduled job or the job scheduler",
        "operationId": "disableScheduledJob",
        "produces": [
          "text/plain",
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "task",
            "description": "The name of the Job to disable. If null the job scheduler itself will be disableped.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/scheduler/trigger": {
      "get": {
        "tags": [
          "ScheduledJobs"
        ],
        "summary": "Trigger a scheduled job immediately and waits for it to complete",
        "operationId": "triggerScheduledJob",
        "produces": [
          "text/plain",
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "task",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/scheduler/{name}/logs": {
      "get": {
        "tags": [
          "ScheduledJobs"
        ],
        "summary": "Get the structured log for a scheduled job",
        "operationId": "getScheduledJobDetails",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tail",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "verbose",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The structured log for a scheduled job",
            "schema": {
              "$ref": "#/definitions/ScheduledTaskDetailsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/scheduler/{name}/logs/raw": {
      "get": {
        "tags": [
          "ScheduledJobs"
        ],
        "summary": "Get the raw log for a scheduled job",
        "operationId": "getScheduledJobRawLogs",
        "produces": [
          "text/plain; charset=UTF-8",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/scopeduserroles": {
      "get": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "List the name and ID of all of the scoped user roles in the supplied Octopus Deploy Space. The results will be sorted by name.",
        "operationId": "getScopedUserRoles_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Scoped User Roles",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "Create a scoped user role.",
        "operationId": "createScopedUserRole_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateScopedUserRoleCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/scopeduserroles/{id}": {
      "get": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "Get a Scoped User Role by ID.",
        "operationId": "getScopedUserRoleById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Scoped User Role.",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "Modify a scoped user role.",
        "operationId": "modifyScopedUserRole_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the scoped user role to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyScopedUserRoleCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Scoped User Role was modified, containing the updated Role",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "Delete an existing Scoped User Role.",
        "operationId": "deleteScopedUserRole_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Scoped User Role to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/scopeduserroles": {
      "get": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "List the name and ID of all of the scoped user roles in the supplied Octopus Deploy Space. The results will be sorted by name.",
        "operationId": "getScopedUserRolesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resources.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Scoped User Roles",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "Create a scoped user role.",
        "operationId": "createScopedUserRoleBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateScopedUserRoleCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/scopeduserroles/{id}": {
      "get": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "Get a Scoped User Role by ID.",
        "operationId": "getScopedUserRoleByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resources.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Scoped User Role.",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "Modify a scoped user role.",
        "operationId": "modifyScopedUserRoleBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the scoped user role to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyScopedUserRoleCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Scoped User Role was modified, containing the updated Role",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "Delete an existing Scoped User Role.",
        "operationId": "deleteScopedUserRoleBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Scoped User Role to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/scopeduserroles": {
      "get": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "List the name and ID of all of the scoped user roles in the supplied Octopus Deploy Space. The results will be sorted by name.",
        "operationId": "getScopedUserRoles",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Scoped User Roles",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "Create a scoped user role.",
        "operationId": "createScopedUserRole",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateScopedUserRoleCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/scopeduserroles/{id}": {
      "get": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "Get a Scoped User Role by ID.",
        "operationId": "getScopedUserRoleById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Scoped User Role.",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "Modify a scoped user role.",
        "operationId": "modifyScopedUserRole",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the scoped user role to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyScopedUserRoleCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Scoped User Role was modified, containing the updated Role",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ScopedUserRoles"
        ],
        "summary": "Delete an existing Scoped User Role.",
        "operationId": "deleteScopedUserRole",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Scoped User Role to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/serverconfiguration": {
      "get": {
        "tags": [
          "Server"
        ],
        "summary": "Request the current server configuration",
        "operationId": "getServerConfiguration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The current server configuration",
            "schema": {
              "$ref": "#/definitions/ServerConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Server"
        ],
        "summary": "Set the server configuration",
        "operationId": "setServerConfiguration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/SetServerConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The updated server configuration",
            "schema": {
              "$ref": "#/definitions/ServerConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/serverconfiguration/settings": {
      "get": {
        "tags": [
          "Server"
        ],
        "summary": "Request the current server configuration settings",
        "operationId": "getServerConfigurationSettings",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The current server configuration settings",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ServerConfigurationSettingsResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/serverstatus": {
      "get": {
        "tags": [
          "ServerStatus"
        ],
        "summary": "Get the status of Octopus Server.",
        "description": "Shows information about the status of the Octopus Server.",
        "operationId": "getServerStatus",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A snapshot of the server's current status",
            "schema": {
              "$ref": "#/definitions/ServerStatusResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/serverstatus/counts": {
      "get": {
        "tags": [
          "ServerStatus"
        ],
        "summary": "Get counts of documents in the server",
        "description": "List counts of various document types to assist in diagnosing issues with the server.",
        "operationId": "getServerDocumentCounts",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested Server Document Counts",
            "schema": {
              "$ref": "#/definitions/ServerDocumentCounts"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/serverstatus/gc-collect": {
      "post": {
        "tags": [
          "ServerStatus"
        ],
        "summary": "Force a GC collect.",
        "description": "Triggers a garbage collection pass for all heap generations, including the large object heap.",
        "operationId": "triggerGarbageCollection",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/serverstatus/gc-collect/v1": {
      "post": {
        "tags": [
          "ServerStatus"
        ],
        "summary": "Force a GC collect.",
        "description": "Triggers a garbage collection pass for all heap generations, including the large object heap.",
        "operationId": "triggerGarbageCollectionV1",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Internal",
            "schema": {
              "$ref": "#/definitions/TriggerGarbageCollectionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/serverstatus/health": {
      "get": {
        "tags": [
          "ServerStatus"
        ],
        "summary": "Get the general health of Octopus Server.",
        "description": "Provides a super simple interface perfect for checking the general health of your entire Octopus Server cluster.",
        "operationId": "getServerStatusHealth",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A snapshot of the server or cluster's current health",
            "schema": {
              "$ref": "#/definitions/ServerStatusHealthResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          },
          "418": {
            "description": "Indicates that the server is not operating normally"
          }
        }
      }
    },
    "/serverstatus/logs": {
      "get": {
        "tags": [
          "ServerStatus"
        ],
        "summary": "Retrieve the most recent high-priority log messages from this execution of the Octopus Server process.",
        "operationId": "getServerLogs",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "includeDetail",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The most recent high-priority log messages from this execution of the Octopus Server process",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ActivityLogElement"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/serverstatus/system-info": {
      "get": {
        "tags": [
          "ServerStatus"
        ],
        "summary": "Provide information about the Octopus Server process and the machine on which it is running.",
        "operationId": "getServerSystemInfo",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Information about the Octopus Server process and the machine on which it is running.",
            "schema": {
              "$ref": "#/definitions/SystemInfoResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/serverstatus/system-report": {
      "get": {
        "tags": [
          "ServerStatus"
        ],
        "summary": "Create a .zip archive containing an aggregate of the other system information APIs.",
        "operationId": "generateSystemReport",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "nodeSpecificOnly",
            "description": "When true, only node-specific sections are included (recent logs, system info, filesystem logs). Defaults to false (full report) when not set.",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/serverstatus/timezones": {
      "get": {
        "tags": [
          "ServerStatus"
        ],
        "summary": "List timezones supported by the server.",
        "operationId": "getServerStatusTimeZones",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested list of timezones supported by the server.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ServerTimezoneResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/servertaskapprovals": {
      "get": {
        "tags": [
          "ServerTaskApprovals"
        ],
        "summary": "Gets a paginated list of server task approvals",
        "operationId": "getAllServerTaskApprovalsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "providerId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "state",
            "description": "See ChangeRequestApprovalState for possible values.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ServerTaskApprovalResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/servertaskapprovals/{id}": {
      "get": {
        "tags": [
          "ServerTaskApprovals"
        ],
        "summary": "Retrieves details of a specific server task approval by its ID.",
        "operationId": "getServerTaskApprovalByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Represents the response containing a single server task approval by its identifier.",
            "schema": {
              "$ref": "#/definitions/ServerTaskApprovalResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tasks/{id}/servertaskapproval": {
      "get": {
        "tags": [
          "ServerTaskApprovals"
        ],
        "summary": "Gets a server task approval and associated approvals by task id",
        "operationId": "getServerTaskApprovalByTaskIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the Server Task Approval.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Server Task.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Server Task Approval and associated approvals",
            "schema": {
              "$ref": "#/definitions/GetServerTaskApprovalByTaskIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/servertaskapprovals": {
      "get": {
        "tags": [
          "ServerTaskApprovals"
        ],
        "summary": "Gets a paginated list of server task approvals",
        "operationId": "getAllServerTaskApprovals",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "providerId",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "state",
            "description": "See ChangeRequestApprovalState for possible values.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/ServerTaskApprovalResourcePaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/servertaskapprovals/{id}": {
      "get": {
        "tags": [
          "ServerTaskApprovals"
        ],
        "summary": "Retrieves details of a specific server task approval by its ID.",
        "operationId": "getServerTaskApprovalById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Represents the response containing a single server task approval by its identifier.",
            "schema": {
              "$ref": "#/definitions/ServerTaskApprovalResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tasks/{id}/servertaskapproval": {
      "get": {
        "tags": [
          "ServerTaskApprovals"
        ],
        "summary": "Gets a server task approval and associated approvals by task id",
        "operationId": "getServerTaskApprovalByTaskId",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the Server Task.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Server Task Approval and associated approvals",
            "schema": {
              "$ref": "#/definitions/GetServerTaskApprovalByTaskIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/serviceaccounts/{serviceAccountId}/oidcidentities/create/v1": {
      "post": {
        "tags": [
          "ServiceAccountOidcIdentities"
        ],
        "summary": "Create new OIDC Identity for a Service Account",
        "operationId": "createServiceAccountOidcIdentityV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "serviceAccountId",
            "description": "The id of the service account that the identity belonds to",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateServiceAccountOidcIdentityCommandV1"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateServiceAccountOidcIdentityResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/serviceaccounts/{serviceAccountId}/oidcidentities/v1": {
      "get": {
        "tags": [
          "ServiceAccountOidcIdentities"
        ],
        "summary": "Get ServiceAccountOidcIdentities",
        "description": "Gets a paginated set of ServiceAccountOidcIdentities.",
        "operationId": "getServiceAccountOidcIdentitiesV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "serviceAccountId",
            "description": "The id of the service account to get OIDC identities for",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Rseponse to getting set of ServiceAccountOidcIdentities",
            "schema": {
              "$ref": "#/definitions/GetServiceAccountOidcIdentitiesResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/serviceaccounts/{serviceAccountId}/oidcidentities/{id}/v1": {
      "get": {
        "tags": [
          "ServiceAccountOidcIdentities"
        ],
        "summary": "Get ServiceAccountOidcIdentity by id",
        "description": "Gets a ServiceAccountOidcIdentity by its id.",
        "operationId": "getServiceAccountOidcIdentityByIdV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "serviceAccountId",
            "description": "The id of the space for the ServiceAccountOidcIdentity.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the ServiceAccountOidcIdentity.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response to getting a ServiceAccountOidcIdentity by id",
            "schema": {
              "$ref": "#/definitions/GetServiceAccountOidcIdentityByIdResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "ServiceAccountOidcIdentities"
        ],
        "summary": "Modify ServiceAccountOidcIdentity",
        "operationId": "modifyServiceAccountOidcIdentityV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "serviceAccountId",
            "description": "The id of the space for the ServiceAccountOidcIdentity.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the ServiceAccountOidcIdentity.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyServiceAccountOidcIdentityCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Response to modifying a ServiceAccountOidcIdentity",
            "schema": {
              "$ref": "#/definitions/ModifyServiceAccountOidcIdentityResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "ServiceAccountOidcIdentities"
        ],
        "summary": "Delete ServiceAccountOidcIdentity",
        "description": "Deletes a ServiceAccountOidcIdentity.",
        "operationId": "deleteServiceAccountOidcIdentityV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "serviceAccountId",
            "description": "The id of the service account that the identity belongs to",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The id of the ServiceAccountOidcIdentity.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Response to deleting a ServiceAccountOidcIdentity",
            "schema": {
              "$ref": "#/definitions/DeleteServiceAccountOidcIdentityResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/signingkeyconfiguration": {
      "get": {
        "tags": [
          "Signing"
        ],
        "summary": "Request the current signing key configuration",
        "operationId": "getSigningKeyConfiguration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The current signing key configuration",
            "schema": {
              "$ref": "#/definitions/SigningKeyConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Signing"
        ],
        "summary": "Set the signing key configuration",
        "operationId": "setSigningKeyConfiguration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/SetSigningKeyConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The updated signing key configuration",
            "schema": {
              "$ref": "#/definitions/SigningKeyConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/signingkeys/pending/generate/v1": {
      "post": {
        "tags": [
          "Signing"
        ],
        "summary": "Create a new key that is pending activation.",
        "operationId": "generatePendingSigningKeyV1",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Returns the Id of the generated signing key.",
            "schema": {
              "$ref": "#/definitions/GeneratePendingSigningKeyResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/signingkeys/pending/{id}/activate/v1": {
      "post": {
        "tags": [
          "Signing"
        ],
        "summary": "Activate an existing pending signing key, making it the active signing key for the system.",
        "operationId": "activatePendingSigningKeyV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Indicates the key was activated",
            "schema": {
              "$ref": "#/definitions/ActivatePendingSigningKeyResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/signingkeys/verify/v1": {
      "post": {
        "tags": [
          "Signing"
        ],
        "summary": "Validate that the public signing keys are valid and can be used to verify signatures. This is intended to be used as a health check for external key hosting, and will return an error if the keys are invalid or expired.",
        "operationId": "verifySigningKeysV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/VerifySigningKeysCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Response to VerifySigningKeysCommandV1. An empty response indicates that the signing keys are valid and can be used to verify signatures. If the signing keys are invalid or expired, an error will be returned instead of this response.",
            "schema": {
              "$ref": "#/definitions/VerifySigningKeysResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/integrations/slack/channels": {
      "get": {
        "tags": [
          "SlackIntegration"
        ],
        "operationId": "getSlackChannelsGet",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/integrations/slack/channels/resolve": {
      "get": {
        "tags": [
          "SlackIntegration"
        ],
        "operationId": "getSlackChannelResolve",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/integrations/slack/configuration": {
      "get": {
        "tags": [
          "SlackIntegration"
        ],
        "operationId": "getSlackConfigurationGet",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/integrations/slack/connection": {
      "delete": {
        "tags": [
          "SlackIntegration"
        ],
        "operationId": "deleteSlackConnectionDisconnect",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/integrations/slack/connection/test": {
      "post": {
        "tags": [
          "SlackIntegration"
        ],
        "operationId": "postSlackConnectionTest",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/integrations/slack/credentials": {
      "post": {
        "tags": [
          "SlackIntegration"
        ],
        "operationId": "postSlackCredentialsPost",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/integrations/slack/oauth/callback": {
      "get": {
        "tags": [
          "SlackIntegration"
        ],
        "operationId": "getSlackOAuthCallback",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/integrations/slack/oauth/start": {
      "get": {
        "tags": [
          "SlackIntegration"
        ],
        "operationId": "getSlackOAuthStart",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/smtpconfiguration": {
      "get": {
        "tags": [
          "Smtp"
        ],
        "summary": "Get information about the SMTP (email) settings in use by the Octopus Server.",
        "operationId": "getSmtpConfiguration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested SMTP configuration",
            "schema": {
              "$ref": "#/definitions/SmtpConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Smtp"
        ],
        "summary": "Update the SMTP settings used by the Octopus Server.",
        "operationId": "modifySmtpConfiguration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifySmtpConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that SMTP Configuration was modified, containing the new configuration",
            "schema": {
              "$ref": "#/definitions/SmtpConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/smtpconfiguration/isconfigured": {
      "get": {
        "tags": [
          "Smtp"
        ],
        "summary": "Check whether SMTP is configured with low privileges",
        "operationId": "getSmtpIsConfigured",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested information about whether SMTP is configured",
            "schema": {
              "$ref": "#/definitions/SmtpIsConfiguredResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/smtpconfiguration/isconfigured/v1": {
      "get": {
        "tags": [
          "Smtp"
        ],
        "summary": "Check whether SMTP is configured with low privileges",
        "operationId": "getSmtpIsConfiguredV1",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested information about whether SMTP is configured",
            "schema": {
              "$ref": "#/definitions/GetSmtpIsConfiguredResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/smtpconfiguration/v1": {
      "get": {
        "tags": [
          "Smtp"
        ],
        "summary": "Get information about the SMTP (email) settings in use by the Octopus Server.",
        "operationId": "getSmtpConfigurationV1",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested SMTP configuration",
            "schema": {
              "$ref": "#/definitions/GetSmtpConfigurationResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a list of Spaces",
        "description": "Lists all of the Spaces in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getSpaces",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "Comma separated list of Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Space to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Spaces",
            "schema": {
              "$ref": "#/definitions/SpaceResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Spaces"
        ],
        "summary": "Create a new Space",
        "operationId": "createSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateSpaceCommandV1"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/SpaceResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/all": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a list of Spaces",
        "description": "Lists all Spaces. The results will be sorted alphabetically by name.",
        "operationId": "getAllSpaces",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a `contains` style match against the supplied name or name-fragment",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Spaces",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/SpaceResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/v1": {
      "post": {
        "tags": [
          "Spaces"
        ],
        "summary": "Create a new Space",
        "operationId": "createSpaceV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateSpaceCommandV1"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateSpaceResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{id}": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a Space by ID",
        "operationId": "getSpaceById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Space to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a space",
            "schema": {
              "$ref": "#/definitions/SpaceResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Spaces"
        ],
        "summary": "Update a Space",
        "operationId": "modifySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifySpaceCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Space was modified, contains the updated Space",
            "schema": {
              "$ref": "#/definitions/SpaceResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Spaces"
        ],
        "summary": "Delete an existing Space.",
        "operationId": "deleteSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Space to be deleted",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{id}/logo": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get the logo for the space with the given space ID.",
        "description": "Gets the logo associated with the space.",
        "operationId": "getSpaceLogo",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the space.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Spaces"
        ],
        "summary": "Modify the logo of the space with the given space ID.",
        "description": "Modifies the logo associated with the space.",
        "operationId": "modifySpaceLogo",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the space.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Spaces"
        ],
        "summary": "Modify the logo of the space with the given space ID.",
        "description": "Modifies the logo associated with the space.",
        "operationId": "modifySpaceLogoUsingPut",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the space.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{id}/search": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Search in the supplied Octopus Deploy Space using the given keyword.",
        "operationId": "searchSpace_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Space to search",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "keyword",
            "description": "A keyword to search. Example: ABC",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Space Search Results",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/SpaceSearchResult"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{id}/v1": {
      "delete": {
        "tags": [
          "Spaces"
        ],
        "summary": "Delete an existing Space.",
        "operationId": "deleteSpaceV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Space to be deleted",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Empty response indicating the Space was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteSpaceResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/{id}/spaces": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a list of spaces available to the current authenticated user only.",
        "operationId": "getSpacesAvailableToUser",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the user whose spaces we are looking up.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Spaces available to the user",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/SpaceResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/git-credentials": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a collection of Git credentials",
        "operationId": "getGitCredentialsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Filters credentials matching any part of the `name` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credentials",
            "schema": {
              "$ref": "#/definitions/GitCredentialResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Spaces"
        ],
        "summary": "Create a new Git credential",
        "operationId": "createGitCredentialBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateGitCredentialCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/git-credentials/v1": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a collection of Git credentials",
        "operationId": "getGitCredentialsV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Filters credentials matching any part of the `name` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credentials",
            "schema": {
              "$ref": "#/definitions/GetGitCredentialsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Spaces"
        ],
        "summary": "Create a new Git credential",
        "operationId": "createGitCredentialV1BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateGitCredentialCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/git-credentials/v2": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a collection of Git credentials",
        "operationId": "getGitCredentialsV2BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Filters credentials matching any part of the `name` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GitCredentialResourceV2PaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Spaces"
        ],
        "summary": "Create a new Git credential",
        "operationId": "createGitCredentialV2BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateGitCredentialCommandV2"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateGitCredentialResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/git-credentials/{id}": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a specific Git credential",
        "operationId": "getGitCredentialByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to get",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credential",
            "schema": {
              "$ref": "#/definitions/GitCredentialResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Spaces"
        ],
        "summary": "Modify an existing Git credential",
        "operationId": "modifyGitCredentialBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyGitCredentialCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Git Credential was modified",
            "schema": {
              "$ref": "#/definitions/ModifyGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Spaces"
        ],
        "summary": "Delete an existing Git credential",
        "operationId": "deleteGitCredentialBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Git Credential has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/git-credentials/{id}/usage": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get usage of a specific Git credential",
        "operationId": "getGitCredentialUsageByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to get usage for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credential Usage",
            "schema": {
              "$ref": "#/definitions/GetGitCredentialUsageByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/git-credentials/{id}/usage/v1": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get usage of a specific Git credential",
        "operationId": "getGitCredentialUsageByIdV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to get usage for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credential Usage",
            "schema": {
              "$ref": "#/definitions/GetGitCredentialUsageByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/git-credentials/{id}/v1": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a specific Git credential",
        "operationId": "getGitCredentialByIdV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to get",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credential",
            "schema": {
              "$ref": "#/definitions/GetGitCredentialByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Spaces"
        ],
        "summary": "Modify an existing Git credential",
        "operationId": "modifyGitCredentialV1BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyGitCredentialCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Git Credential was modified",
            "schema": {
              "$ref": "#/definitions/ModifyGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Spaces"
        ],
        "summary": "Delete an existing Git credential",
        "operationId": "deleteGitCredentialV1BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Git Credential has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/git-credentials/{id}/v2": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a specific Git credential",
        "operationId": "getGitCredentialByIdV2BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to get",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credential",
            "schema": {
              "$ref": "#/definitions/GetGitCredentialByIdResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Spaces"
        ],
        "summary": "Modify an existing Git credential",
        "operationId": "modifyGitCredentialV2BySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyGitCredentialCommandV2"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Git Credential was modified",
            "schema": {
              "$ref": "#/definitions/ModifyGitCredentialResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/git/refs": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get the git references that match the given rule pattern for a project",
        "operationId": "getMatchingRefsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "patterns",
            "required": true,
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Response contain a set of Git references that match the rule pattern for the project",
            "schema": {
              "$ref": "#/definitions/GetMatchingRefsResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/spaces/{id}/search": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Search in the supplied Octopus Deploy Space using the given keyword.",
        "operationId": "searchSpaceBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Space to search",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "keyword",
            "description": "A keyword to search. Example: ABC",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Space Search Results",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/SpaceSearchResult"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/git-credentials": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a collection of Git credentials",
        "operationId": "getGitCredentials",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Filters credentials matching any part of the `name` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credentials",
            "schema": {
              "$ref": "#/definitions/GitCredentialResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Spaces"
        ],
        "summary": "Create a new Git credential",
        "operationId": "createGitCredential",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateGitCredentialCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/git-credentials/v1": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a collection of Git credentials",
        "operationId": "getGitCredentialsV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Filters credentials matching any part of the `name` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credentials",
            "schema": {
              "$ref": "#/definitions/GetGitCredentialsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Spaces"
        ],
        "summary": "Create a new Git credential",
        "operationId": "createGitCredentialV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateGitCredentialCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/git-credentials/v2": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a collection of Git credentials",
        "operationId": "getGitCredentialsV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Filters credentials matching any part of the `name` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/GitCredentialResourceV2PaginatedCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Spaces"
        ],
        "summary": "Create a new Git credential",
        "operationId": "createGitCredentialV2",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateGitCredentialCommandV2"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CreateGitCredentialResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/git-credentials/{id}": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a specific Git credential",
        "operationId": "getGitCredentialById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to get",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credential",
            "schema": {
              "$ref": "#/definitions/GitCredentialResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Spaces"
        ],
        "summary": "Modify an existing Git credential",
        "operationId": "modifyGitCredential",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyGitCredentialCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Git Credential was modified",
            "schema": {
              "$ref": "#/definitions/ModifyGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Spaces"
        ],
        "summary": "Delete an existing Git credential",
        "operationId": "deleteGitCredential",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Git Credential has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/git-credentials/{id}/usage": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get usage of a specific Git credential",
        "operationId": "getGitCredentialUsageById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to get usage for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credential Usage",
            "schema": {
              "$ref": "#/definitions/GetGitCredentialUsageByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/git-credentials/{id}/usage/v1": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get usage of a specific Git credential",
        "operationId": "getGitCredentialUsageByIdV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to get usage for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credential Usage",
            "schema": {
              "$ref": "#/definitions/GetGitCredentialUsageByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/git-credentials/{id}/v1": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a specific Git credential",
        "operationId": "getGitCredentialByIdV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to get",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credential",
            "schema": {
              "$ref": "#/definitions/GetGitCredentialByIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Spaces"
        ],
        "summary": "Modify an existing Git credential",
        "operationId": "modifyGitCredentialV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyGitCredentialCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Git Credential was modified",
            "schema": {
              "$ref": "#/definitions/ModifyGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Spaces"
        ],
        "summary": "Delete an existing Git credential",
        "operationId": "deleteGitCredentialV1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Git Credential has been deleted",
            "schema": {
              "$ref": "#/definitions/DeleteGitCredentialResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/git-credentials/{id}/v2": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get a specific Git credential",
        "operationId": "getGitCredentialByIdV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Git credential to get",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Git Credential",
            "schema": {
              "$ref": "#/definitions/GetGitCredentialByIdResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Spaces"
        ],
        "summary": "Modify an existing Git credential",
        "operationId": "modifyGitCredentialV2",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyGitCredentialCommandV2"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Git Credential was modified",
            "schema": {
              "$ref": "#/definitions/ModifyGitCredentialResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/git/refs": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Get the git references that match the given rule pattern for a project",
        "operationId": "getMatchingRefs",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "patterns",
            "required": true,
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to skip. Defaults to zero",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Response contain a set of Git references that match the rule pattern for the project",
            "schema": {
              "$ref": "#/definitions/GetMatchingRefsResponseV1"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/spaces/{id}/search": {
      "get": {
        "tags": [
          "Spaces"
        ],
        "summary": "Search in the supplied Octopus Deploy Space using the given keyword.",
        "operationId": "searchSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Space to search",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "keyword",
            "description": "A keyword to search. Example: ABC",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Space Search Results",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/SpaceSearchResult"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/sshknownhosts": {
      "get": {
        "tags": [
          "SshKnownHosts"
        ],
        "summary": "Get a list of SSH Known Hosts",
        "operationId": "getSshKnownHosts",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "partialHost",
            "description": "Filters known hosts matching any part of the `host` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a list of SSH Known Hosts",
            "schema": {
              "$ref": "#/definitions/GetSshKnownHostsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "SshKnownHosts"
        ],
        "summary": "Add new SSH Known Hosts from a list of entries",
        "operationId": "addSshKnownHosts",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/AddSshKnownHostsCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Contains a list of added SSH Known Hosts",
            "schema": {
              "$ref": "#/definitions/AddSshKnownHostsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/sshknownhosts/{id}": {
      "delete": {
        "tags": [
          "SshKnownHosts"
        ],
        "summary": "Delete the specific SSH Known Host",
        "operationId": "deleteSshKnownHost",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "An empty response",
            "schema": {
              "$ref": "#/definitions/DeleteSshKnownHostResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/subscriptions": {
      "get": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Get a list of Subscriptions",
        "description": "Lists all of the Subscriptions in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getSubscriptions_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Subscriptions",
            "schema": {
              "$ref": "#/definitions/SubscriptionResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Create a new Subscription",
        "operationId": "createSubscription_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateSubscriptionCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/SubscriptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/subscriptions/all": {
      "get": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Get all Subscriptions",
        "description": "Lists all the Subscriptions in the supplied Octopus Deploy Space",
        "operationId": "getAllSubscriptions_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "All Subscriptions from the requested Space",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/SubscriptionResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/subscriptions/{id}": {
      "get": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Get a Subscription by ID",
        "operationId": "getSubscriptionById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Subscription to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Subscription",
            "schema": {
              "$ref": "#/definitions/SubscriptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Update an existing Subscription",
        "operationId": "modifySubscription_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Subscription to modify",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifySubscriptionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The updated Subscription",
            "schema": {
              "$ref": "#/definitions/SubscriptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Delete an existing Subscription",
        "operationId": "deleteSubscription_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Subscription to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Subscription was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteSubscriptionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/subscriptions": {
      "get": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Get a list of Subscriptions",
        "description": "Lists all of the Subscriptions in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getSubscriptionsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Subscriptions",
            "schema": {
              "$ref": "#/definitions/SubscriptionResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Create a new Subscription",
        "operationId": "createSubscriptionBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateSubscriptionCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/SubscriptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/subscriptions/all": {
      "get": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Get all Subscriptions",
        "description": "Lists all the Subscriptions in the supplied Octopus Deploy Space",
        "operationId": "getAllSubscriptionsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "All Subscriptions from the requested Space",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/SubscriptionResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/subscriptions/{id}": {
      "get": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Get a Subscription by ID",
        "operationId": "getSubscriptionByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Subscription to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Subscription",
            "schema": {
              "$ref": "#/definitions/SubscriptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Update an existing Subscription",
        "operationId": "modifySubscriptionBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Subscription to modify",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifySubscriptionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The updated Subscription",
            "schema": {
              "$ref": "#/definitions/SubscriptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Delete an existing Subscription",
        "operationId": "deleteSubscriptionBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Subscription to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Subscription was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteSubscriptionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/subscriptions": {
      "get": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Get a list of Subscriptions",
        "description": "Lists all of the Subscriptions in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getSubscriptions",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Subscriptions",
            "schema": {
              "$ref": "#/definitions/SubscriptionResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Create a new Subscription",
        "operationId": "createSubscription",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateSubscriptionCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/SubscriptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/subscriptions/all": {
      "get": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Get all Subscriptions",
        "description": "Lists all the Subscriptions in the supplied Octopus Deploy Space",
        "operationId": "getAllSubscriptions",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "All Subscriptions from the requested Space",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/SubscriptionResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/subscriptions/{id}": {
      "get": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Get a Subscription by ID",
        "operationId": "getSubscriptionById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Subscription to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Subscription",
            "schema": {
              "$ref": "#/definitions/SubscriptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Update an existing Subscription",
        "operationId": "modifySubscription",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Subscription to modify",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifySubscriptionCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The updated Subscription",
            "schema": {
              "$ref": "#/definitions/SubscriptionResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Subscriptions"
        ],
        "summary": "Delete an existing Subscription",
        "operationId": "deleteSubscription",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Subscription to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Subscription was deleted",
            "schema": {
              "$ref": "#/definitions/DeleteSubscriptionResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tagsets": {
      "get": {
        "tags": [
          "TagSets"
        ],
        "summary": "Get a list of Tag Sets",
        "description": "Lists all of the Tag Sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by the `SortOrder` field on each tag set.",
        "operationId": "getTagSets_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "Comma separated list of Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Tag Set to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \\\"contains\\\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "scopes",
            "description": "Limits results to tag sets that apply to any of these resource types. Valid values: 'Tenant', 'Environment', 'Project', 'Target', 'Runbook', 'Feature Toggle'.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "types",
            "description": "Limits results to tag sets of these types. Valid values: 'SingleSelect', 'MultiSelect', 'FreeText'.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of matching Tag Sets, sorted alphabetically by the `SortOrder` field on each tag set.",
            "schema": {
              "$ref": "#/definitions/TagSetResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "TagSets"
        ],
        "summary": "Create a new Tag Set.",
        "operationId": "createTagSet_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateTagSetCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/TagSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tagsets/all": {
      "get": {
        "tags": [
          "TagSets"
        ],
        "summary": "Get a list of Tag Sets",
        "description": "Lists the details of all of the Tag Sets in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each Tag Set.",
        "operationId": "getAllTagSets_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "scopes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "List of Tag Sets, sorted by the `SortOrder` field on each Tag Set.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TagSetResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tagsets/sortorder": {
      "put": {
        "tags": [
          "TagSets"
        ],
        "description": "Takes an array of tag set IDs as the request body, uses the order of items in the array to sort the tag sets on the server. The ID of every tag set must be specified.",
        "operationId": "SortTagSets_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/tagsets/{id}": {
      "get": {
        "tags": [
          "TagSets"
        ],
        "summary": "Get a Tag Set by ID",
        "operationId": "getTagSetById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tag Set to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Tag Set",
            "schema": {
              "$ref": "#/definitions/TagSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "TagSets"
        ],
        "summary": "Modify an existing Tag Set.",
        "operationId": "modifyTagSet_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tag Set to modify",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyTagSetCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a Tag Set has been modified, containing the updated Tag Set",
            "schema": {
              "$ref": "#/definitions/TagSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "TagSets"
        ],
        "summary": "Delete an existing Tag Set",
        "operationId": "deleteTagSet_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tag Set to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tagsets": {
      "get": {
        "tags": [
          "TagSets"
        ],
        "summary": "Get a list of Tag Sets",
        "description": "Lists all of the Tag Sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by the `SortOrder` field on each tag set.",
        "operationId": "getTagSetsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Comma separated list of Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Tag Set to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \\\"contains\\\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "scopes",
            "description": "Limits results to tag sets that apply to any of these resource types. Valid values: 'Tenant', 'Environment', 'Project', 'Target', 'Runbook', 'Feature Toggle'.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "types",
            "description": "Limits results to tag sets of these types. Valid values: 'SingleSelect', 'MultiSelect', 'FreeText'.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of matching Tag Sets, sorted alphabetically by the `SortOrder` field on each tag set.",
            "schema": {
              "$ref": "#/definitions/TagSetResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "TagSets"
        ],
        "summary": "Create a new Tag Set.",
        "operationId": "createTagSetBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateTagSetCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/TagSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tagsets/all": {
      "get": {
        "tags": [
          "TagSets"
        ],
        "summary": "Get a list of Tag Sets",
        "description": "Lists the details of all of the Tag Sets in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each Tag Set.",
        "operationId": "getAllTagSetsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "scopes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "List of Tag Sets, sorted by the `SortOrder` field on each Tag Set.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TagSetResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tagsets/sortorder": {
      "put": {
        "tags": [
          "TagSets"
        ],
        "description": "Takes an array of tag set IDs as the request body, uses the order of items in the array to sort the tag sets on the server. The ID of every tag set must be specified.",
        "operationId": "SortTagSetsBySpace",
        "consumes": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/{spaceId}/tagsets/{id}": {
      "get": {
        "tags": [
          "TagSets"
        ],
        "summary": "Get a Tag Set by ID",
        "operationId": "getTagSetByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tag Set to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Tag Set",
            "schema": {
              "$ref": "#/definitions/TagSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "TagSets"
        ],
        "summary": "Modify an existing Tag Set.",
        "operationId": "modifyTagSetBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tag Set to modify",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyTagSetCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a Tag Set has been modified, containing the updated Tag Set",
            "schema": {
              "$ref": "#/definitions/TagSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "TagSets"
        ],
        "summary": "Delete an existing Tag Set",
        "operationId": "deleteTagSetBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tag Set to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tagsets": {
      "get": {
        "tags": [
          "TagSets"
        ],
        "summary": "Get a list of Tag Sets",
        "description": "Lists all of the Tag Sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by the `SortOrder` field on each tag set.",
        "operationId": "getTagSets",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Comma separated list of Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Tag Set to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \\\"contains\\\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "scopes",
            "description": "Limits results to tag sets that apply to any of these resource types. Valid values: 'Tenant', 'Environment', 'Project', 'Target', 'Runbook', 'Feature Toggle'.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "types",
            "description": "Limits results to tag sets of these types. Valid values: 'SingleSelect', 'MultiSelect', 'FreeText'.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of matching Tag Sets, sorted alphabetically by the `SortOrder` field on each tag set.",
            "schema": {
              "$ref": "#/definitions/TagSetResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "TagSets"
        ],
        "summary": "Create a new Tag Set.",
        "operationId": "createTagSet",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateTagSetCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/TagSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tagsets/all": {
      "get": {
        "tags": [
          "TagSets"
        ],
        "summary": "Get a list of Tag Sets",
        "description": "Lists the details of all of the Tag Sets in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each Tag Set.",
        "operationId": "getAllTagSets",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "scopes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "List of Tag Sets, sorted by the `SortOrder` field on each Tag Set.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TagSetResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tagsets/sortorder": {
      "put": {
        "tags": [
          "TagSets"
        ],
        "description": "Takes an array of tag set IDs as the request body, uses the order of items in the array to sort the tag sets on the server. The ID of every tag set must be specified.",
        "operationId": "SortTagSets",
        "consumes": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tagsets/{id}": {
      "get": {
        "tags": [
          "TagSets"
        ],
        "summary": "Get a Tag Set by ID",
        "operationId": "getTagSetById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tag Set to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Tag Set",
            "schema": {
              "$ref": "#/definitions/TagSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "TagSets"
        ],
        "summary": "Modify an existing Tag Set.",
        "operationId": "modifyTagSet",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tag Set to modify",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyTagSetCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a Tag Set has been modified, containing the updated Tag Set",
            "schema": {
              "$ref": "#/definitions/TagSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "TagSets"
        ],
        "summary": "Delete an existing Tag Set",
        "operationId": "deleteTagSet",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tag Set to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tasks": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "List all of the tasks in the supplied Octopus Deploy Space. The results will be sorted from newest to oldest.",
        "operationId": "listServerTasks_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "active",
            "description": "Set to true for tasks that have not finished (New, Queued, Executing or Cancelling), or false for tasks that have",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "batch",
            "type": "string"
          },
          {
            "in": "query",
            "name": "description",
            "description": "Text to match within a task's description, such as a project or release name. This is a partial match, not an exact one",
            "type": "string"
          },
          {
            "in": "query",
            "name": "environment",
            "description": "The ID of an environment, to return only tasks against that environment. This is an ID such as 'Environments-1', not an environment name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "fromCompletedDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "fromQueueDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "fromStartDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "hasPendingInterruptions",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "hasPendingPreconditions",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "hasWarningsOrErrors",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Task IDs to return, such as 'ServerTasks-1'",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Task type names to match exactly, such as 'Deploy' or 'RunbookRun'. Use ListServerTaskTypes to get the supported values",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "node",
            "description": "The ID of the Octopus Server node a task ran on, to return only tasks from that node",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial task type name, to match tasks whose type name includes it",
            "type": "string"
          },
          {
            "in": "query",
            "name": "project",
            "description": "The ID of a project, to return only tasks against that project. This is an ID such as 'Projects-1', not a project name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbook",
            "description": "The ID of a runbook, to return only runs of that runbook",
            "type": "string"
          },
          {
            "in": "query",
            "name": "running",
            "description": "Set to true for tasks currently in progress (Executing or Cancelling), or false for tasks that are not",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "states",
            "description": "Task states to match. One or more of New, Queued, Executing, Cancelling, Success, Failed, Canceled, TimedOut",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "The ID of a tenant, to return only tasks against that tenant. This is an ID such as 'Tenants-1', not a tenant name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantTag",
            "description": "A tenant tag in canonical form, such as 'Regions/EMEA', to return only tasks against tenants carrying it",
            "type": "string"
          },
          {
            "in": "query",
            "name": "toCompletedDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "toQueueDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "toStartDate",
            "type": "string",
            "format": "date-time"
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a TaskResourceCollection generated in response to a ListServerTasksRequest",
            "schema": {
              "$ref": "#/definitions/TaskResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Create a new Task.",
        "operationId": "createServerTask_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateServerTaskCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tasks/rerun/{id}": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Create a new task and execute it, using a given task as the input. Note that deployment tasks cannot be re-run.",
        "operationId": "rerunServerTask_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task to re-run.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Carries the new task created in response to re-running an existing task via RerunServerTaskCommand.",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tasks/tasktypes": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "List supported task types.",
        "operationId": "listServerTaskTypes_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Holds a list of supported task types, generated in response to a ListServerTaskTypesRequest",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TaskTypeResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tasks/{id}": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get a single Task by ID.",
        "operationId": "getServerTaskById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a task, returned in response to GetServerTaskByIdRequest",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tasks/{id}/cancel": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Mark the given task as canceled.",
        "operationId": "cancelServerTask_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task to cancel",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returned in response to CancelServerTaskRequest. If the ServerTask cancellation failed, clients should receive an error instead.",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tasks/{id}/details": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get a single task by ID, including the full task log as a tree of activity elements.",
        "operationId": "getServerTaskDetails_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the task to load details for",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ranges",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tail",
            "description": "If set, determines how many log entries will be returned",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "verbose",
            "description": "If true, includes verbose output",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns details about a specific server task",
            "schema": {
              "$ref": "#/definitions/TaskDetailsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tasks/{id}/prioritize": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Prioritize given task to the top of the Task Queue",
        "operationId": "prioritizeServerTask_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tasks/{id}/queued-behind": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get a list of tasks that this task is currently queued behind.",
        "operationId": "getServerTaskQueuedBehind_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Holds the list of tasks that a task is currently queued behind. Response to GetServerTaskQueuedBehindRequest.",
            "schema": {
              "$ref": "#/definitions/TaskResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tasks/{id}/raw": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get the full task log of a given resource as plain text. Useful when the log needs to be rendered to a console or sent as an email attachment.",
        "operationId": "getServerTaskRaw_LegacyDefaultSpace",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the task",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tasks/{id}/state": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Change the state of a task",
        "operationId": "modifyServerTaskState_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the task",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyServerTaskStateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Task resource after the state has been changed in response to a ModifyServerTaskStateCommand",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tasks/{id}/status/messages": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get messages for a single Task by Id",
        "operationId": "getServerTaskStatusMessages_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task to load status messages for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Task Status Messages",
            "schema": {
              "$ref": "#/definitions/GetServerTaskStatusMessagesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tasks": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "List all of the tasks in the supplied Octopus Deploy Space. The results will be sorted from newest to oldest.",
        "operationId": "listServerTasksBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "active",
            "description": "Set to true for tasks that have not finished (New, Queued, Executing or Cancelling), or false for tasks that have",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "batch",
            "type": "string"
          },
          {
            "in": "query",
            "name": "description",
            "description": "Text to match within a task's description, such as a project or release name. This is a partial match, not an exact one",
            "type": "string"
          },
          {
            "in": "query",
            "name": "environment",
            "description": "The ID of an environment, to return only tasks against that environment. This is an ID such as 'Environments-1', not an environment name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "fromCompletedDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "fromQueueDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "fromStartDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "hasPendingInterruptions",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "hasPendingPreconditions",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "hasWarningsOrErrors",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Task IDs to return, such as 'ServerTasks-1'",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Task type names to match exactly, such as 'Deploy' or 'RunbookRun'. Use ListServerTaskTypes to get the supported values",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "node",
            "description": "The ID of the Octopus Server node a task ran on, to return only tasks from that node",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial task type name, to match tasks whose type name includes it",
            "type": "string"
          },
          {
            "in": "query",
            "name": "project",
            "description": "The ID of a project, to return only tasks against that project. This is an ID such as 'Projects-1', not a project name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbook",
            "description": "The ID of a runbook, to return only runs of that runbook",
            "type": "string"
          },
          {
            "in": "query",
            "name": "running",
            "description": "Set to true for tasks currently in progress (Executing or Cancelling), or false for tasks that are not",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "states",
            "description": "Task states to match. One or more of New, Queued, Executing, Cancelling, Success, Failed, Canceled, TimedOut",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "The ID of a tenant, to return only tasks against that tenant. This is an ID such as 'Tenants-1', not a tenant name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantTag",
            "description": "A tenant tag in canonical form, such as 'Regions/EMEA', to return only tasks against tenants carrying it",
            "type": "string"
          },
          {
            "in": "query",
            "name": "toCompletedDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "toQueueDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "toStartDate",
            "type": "string",
            "format": "date-time"
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a TaskResourceCollection generated in response to a ListServerTasksRequest",
            "schema": {
              "$ref": "#/definitions/TaskResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Create a new Task.",
        "operationId": "createServerTaskBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateServerTaskCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tasks/rerun/{id}": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Create a new task and execute it, using a given task as the input. Note that deployment tasks cannot be re-run.",
        "operationId": "rerunServerTaskBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resources.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task to re-run.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Carries the new task created in response to re-running an existing task via RerunServerTaskCommand.",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tasks/tasktypes": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "List supported task types.",
        "operationId": "listServerTaskTypesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a list of supported task types, generated in response to a ListServerTaskTypesRequest",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TaskTypeResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tasks/{id}": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get a single Task by ID.",
        "operationId": "getServerTaskByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resources.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a task, returned in response to GetServerTaskByIdRequest",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tasks/{id}/cancel": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Mark the given task as canceled.",
        "operationId": "cancelServerTaskBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resources.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task to cancel",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returned in response to CancelServerTaskRequest. If the ServerTask cancellation failed, clients should receive an error instead.",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tasks/{id}/details": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get a single task by ID, including the full task log as a tree of activity elements.",
        "operationId": "getServerTaskDetailsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the task to load details for",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ranges",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tail",
            "description": "If set, determines how many log entries will be returned",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "verbose",
            "description": "If true, includes verbose output",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns details about a specific server task",
            "schema": {
              "$ref": "#/definitions/TaskDetailsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tasks/{id}/prioritize": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Prioritize given task to the top of the Task Queue",
        "operationId": "prioritizeServerTaskBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tasks/{id}/queued-behind": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get a list of tasks that this task is currently queued behind.",
        "operationId": "getServerTaskQueuedBehindBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Holds the list of tasks that a task is currently queued behind. Response to GetServerTaskQueuedBehindRequest.",
            "schema": {
              "$ref": "#/definitions/TaskResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tasks/{id}/raw": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get the full task log of a given resource as plain text. Useful when the log needs to be rendered to a console or sent as an email attachment.",
        "operationId": "getServerTaskRawBySpace",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the task",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tasks/{id}/state": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Change the state of a task",
        "operationId": "modifyServerTaskStateBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the task",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyServerTaskStateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Task resource after the state has been changed in response to a ModifyServerTaskStateCommand",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tasks/{id}/status/messages": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get messages for a single Task by Id",
        "operationId": "getServerTaskStatusMessagesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resources.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task to load status messages for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Task Status Messages",
            "schema": {
              "$ref": "#/definitions/GetServerTaskStatusMessagesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tasks": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "List all of the tasks in the supplied Octopus Deploy Space. The results will be sorted from newest to oldest.",
        "operationId": "listServerTasks",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "active",
            "description": "Set to true for tasks that have not finished (New, Queued, Executing or Cancelling), or false for tasks that have",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "batch",
            "type": "string"
          },
          {
            "in": "query",
            "name": "description",
            "description": "Text to match within a task's description, such as a project or release name. This is a partial match, not an exact one",
            "type": "string"
          },
          {
            "in": "query",
            "name": "environment",
            "description": "The ID of an environment, to return only tasks against that environment. This is an ID such as 'Environments-1', not an environment name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "fromCompletedDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "fromQueueDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "fromStartDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "hasPendingInterruptions",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "hasPendingPreconditions",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "hasWarningsOrErrors",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Task IDs to return, such as 'ServerTasks-1'",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "Task type names to match exactly, such as 'Deploy' or 'RunbookRun'. Use ListServerTaskTypes to get the supported values",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "node",
            "description": "The ID of the Octopus Server node a task ran on, to return only tasks from that node",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial task type name, to match tasks whose type name includes it",
            "type": "string"
          },
          {
            "in": "query",
            "name": "project",
            "description": "The ID of a project, to return only tasks against that project. This is an ID such as 'Projects-1', not a project name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbook",
            "description": "The ID of a runbook, to return only runs of that runbook",
            "type": "string"
          },
          {
            "in": "query",
            "name": "running",
            "description": "Set to true for tasks currently in progress (Executing or Cancelling), or false for tasks that are not",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "states",
            "description": "Task states to match. One or more of New, Queued, Executing, Cancelling, Success, Failed, Canceled, TimedOut",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "The ID of a tenant, to return only tasks against that tenant. This is an ID such as 'Tenants-1', not a tenant name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantTag",
            "description": "A tenant tag in canonical form, such as 'Regions/EMEA', to return only tasks against tenants carrying it",
            "type": "string"
          },
          {
            "in": "query",
            "name": "toCompletedDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "toQueueDate",
            "type": "string",
            "format": "date-time"
          },
          {
            "in": "query",
            "name": "toStartDate",
            "type": "string",
            "format": "date-time"
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a TaskResourceCollection generated in response to a ListServerTasksRequest",
            "schema": {
              "$ref": "#/definitions/TaskResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Create a new Task.",
        "operationId": "createServerTask",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateServerTaskCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tasks/rerun/{id}": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Create a new task and execute it, using a given task as the input. Note that deployment tasks cannot be re-run.",
        "operationId": "rerunServerTask",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task to re-run.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Carries the new task created in response to re-running an existing task via RerunServerTaskCommand.",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tasks/tasktypes": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "List supported task types.",
        "operationId": "listServerTaskTypes",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a list of supported task types, generated in response to a ListServerTaskTypesRequest",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TaskTypeResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tasks/{id}": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get a single Task by ID.",
        "operationId": "getServerTaskById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Holds a task, returned in response to GetServerTaskByIdRequest",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tasks/{id}/cancel": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Mark the given task as canceled.",
        "operationId": "cancelServerTask",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task to cancel",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returned in response to CancelServerTaskRequest. If the ServerTask cancellation failed, clients should receive an error instead.",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tasks/{id}/details": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get a single task by ID, including the full task log as a tree of activity elements.",
        "operationId": "getServerTaskDetails",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the task to load details for",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ranges",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tail",
            "description": "If set, determines how many log entries will be returned",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "verbose",
            "description": "If true, includes verbose output",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns details about a specific server task",
            "schema": {
              "$ref": "#/definitions/TaskDetailsResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tasks/{id}/prioritize": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Prioritize given task to the top of the Task Queue",
        "operationId": "prioritizeServerTask",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tasks/{id}/queued-behind": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get a list of tasks that this task is currently queued behind.",
        "operationId": "getServerTaskQueuedBehind",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Holds the list of tasks that a task is currently queued behind. Response to GetServerTaskQueuedBehindRequest.",
            "schema": {
              "$ref": "#/definitions/TaskResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tasks/{id}/raw": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get the full task log of a given resource as plain text. Useful when the log needs to be rendered to a console or sent as an email attachment.",
        "operationId": "getServerTaskRaw",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the task",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tasks/{id}/state": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Change the state of a task",
        "operationId": "modifyServerTaskState",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the task",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyServerTaskStateCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the Task resource after the state has been changed in response to a ModifyServerTaskStateCommand",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tasks/{id}/status/messages": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Get messages for a single Task by Id",
        "operationId": "getServerTaskStatusMessages",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Task to load status messages for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Task Status Messages",
            "schema": {
              "$ref": "#/definitions/GetServerTaskStatusMessagesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/teammembership": {
      "get": {
        "tags": [
          "TeamMemberships"
        ],
        "summary": "Get a list of Team Memberships for a user.",
        "description": "Lists all Teams a user is a member of, including any from external auth-provider security groups. Memberships are filtered by userId.",
        "operationId": "getTeamMembershipByUserId_LegacyDefaultSpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "userId",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Team Membership",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TeamMembership"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/teammembership/previewteam": {
      "post": {
        "tags": [
          "TeamMemberships"
        ],
        "summary": "Preview Users that would belong to the specified Team",
        "description": "Lists all the Users that would belong to the specified Team, including information about whether they are directly assigned and/or indirectly assigned via external security groups.",
        "operationId": "getTeamMembershipPreview_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetTeamMembershipPreviewRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Preview of Team Membership",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TeamMembershipPreview"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/{userId}/teams": {
      "get": {
        "tags": [
          "TeamMemberships"
        ],
        "summary": "Get a list of Team Memberships for a user.",
        "description": "Lists all Teams a user is a member of, including any from external auth-provider security groups. Memberships are filtered by userId.",
        "operationId": "getTeamMembershipByUserId_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "userId",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Team Membership",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectedTeamReferenceDataItem"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/teammembership": {
      "get": {
        "tags": [
          "TeamMemberships"
        ],
        "summary": "Get a list of Team Memberships for a user.",
        "description": "Lists all Teams a user is a member of, including any from external auth-provider security groups. Memberships are filtered by userId.",
        "operationId": "getTeamMembershipByUserIdBySpace_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resources.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "userId",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Team Membership",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TeamMembership"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/teammembership/previewteam": {
      "post": {
        "tags": [
          "TeamMemberships"
        ],
        "summary": "Preview Users that would belong to the specified Team",
        "description": "Lists all the Users that would belong to the specified Team, including information about whether they are directly assigned and/or indirectly assigned via external security groups.",
        "operationId": "getTeamMembershipPreviewBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetTeamMembershipPreviewRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Preview of Team Membership",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TeamMembershipPreview"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/users/{userId}/teams": {
      "get": {
        "tags": [
          "TeamMemberships"
        ],
        "summary": "Get a list of Team Memberships for a user.",
        "description": "Lists all Teams a user is a member of, including any from external auth-provider security groups. Memberships are filtered by userId.",
        "operationId": "getTeamMembershipByUserIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resources.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "userId",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Team Membership",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectedTeamReferenceDataItem"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/teammembership": {
      "get": {
        "tags": [
          "TeamMemberships"
        ],
        "summary": "Get a list of Team Memberships for a user.",
        "description": "Lists all Teams a user is a member of, including any from external auth-provider security groups. Memberships are filtered by userId.",
        "operationId": "getTeamMembershipByUserId_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "userId",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Team Membership",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TeamMembership"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/teammembership/previewteam": {
      "post": {
        "tags": [
          "TeamMemberships"
        ],
        "summary": "Preview Users that would belong to the specified Team",
        "description": "Lists all the Users that would belong to the specified Team, including information about whether they are directly assigned and/or indirectly assigned via external security groups.",
        "operationId": "getTeamMembershipPreview",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/GetTeamMembershipPreviewRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Preview of Team Membership",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TeamMembershipPreview"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/users/{userId}/teams": {
      "get": {
        "tags": [
          "TeamMemberships"
        ],
        "summary": "Get a list of Team Memberships for a user.",
        "description": "Lists all Teams a user is a member of, including any from external auth-provider security groups. Memberships are filtered by userId.",
        "operationId": "getTeamMembershipByUserId",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "userId",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Team Membership",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ProjectedTeamReferenceDataItem"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/teams": {
      "get": {
        "tags": [
          "Teams"
        ],
        "summary": "Get a list of Teams",
        "description": "Lists all of the Teams in the system or Octopus Deploy Space (if provided). The results will be sorted alphabetically by name.",
        "operationId": "getTeams_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Team IDs, to limit the matching of Teams to those with a particular ID. Example: [\"Teams-1\", \"Teams-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Team to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Teams to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Teams",
            "schema": {
              "$ref": "#/definitions/TeamResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Teams"
        ],
        "summary": "Create a new team",
        "operationId": "createTeam_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateTeamCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/TeamResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/teams/all": {
      "get": {
        "tags": [
          "Teams"
        ],
        "summary": "Get a list of Teams",
        "description": "Lists all of the Teams in the supplied Octopus Deploy Space. The results will be sorted by name.",
        "operationId": "getAllTeams_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested list of Teams",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TeamResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/teams/{id}": {
      "get": {
        "tags": [
          "Teams"
        ],
        "summary": "Get a Team by ID",
        "operationId": "getTeamById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the team.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Team",
            "schema": {
              "$ref": "#/definitions/TeamResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Teams"
        ],
        "summary": "Modify an existing Team",
        "description": "The Everyone Team is treated as a special case and its members and external groups may not be changed.",
        "operationId": "modifyTeam_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyTeamCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Indicates the team was modified, containing the updated Team",
            "schema": {
              "$ref": "#/definitions/TeamResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Teams"
        ],
        "summary": "Delete an existing Team.",
        "operationId": "deleteTeam_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Team to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/teams/{id}/scopeduserroles": {
      "get": {
        "tags": [
          "Teams"
        ],
        "summary": "Get a list of a Team's Scoped User Roles.",
        "description": "List all the Scoped User Roles for the Team. Results will be sorted by Space Id with System Teams being sorted before Space Teams.",
        "operationId": "getTeamScopedUserRoles_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Scoped User Roles",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/teams": {
      "get": {
        "tags": [
          "Teams"
        ],
        "summary": "Get a list of Teams",
        "description": "Lists all of the Teams in the system or Octopus Deploy Space (if provided). The results will be sorted alphabetically by name.",
        "operationId": "getTeamsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resources.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Team IDs, to limit the matching of Teams to those with a particular ID. Example: [\"Teams-1\", \"Teams-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Team to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Teams to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Teams",
            "schema": {
              "$ref": "#/definitions/TeamResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Teams"
        ],
        "summary": "Create a new team",
        "operationId": "createTeamBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The space in which to create the team.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateTeamCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/TeamResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/teams/all": {
      "get": {
        "tags": [
          "Teams"
        ],
        "summary": "Get a list of Teams",
        "description": "Lists all of the Teams in the supplied Octopus Deploy Space. The results will be sorted by name.",
        "operationId": "getAllTeamsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Teams",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TeamResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/teams/{id}": {
      "get": {
        "tags": [
          "Teams"
        ],
        "summary": "Get a Team by ID",
        "operationId": "getTeamByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resources.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the team.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Team",
            "schema": {
              "$ref": "#/definitions/TeamResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Teams"
        ],
        "summary": "Modify an existing Team",
        "description": "The Everyone Team is treated as a special case and its members and external groups may not be changed.",
        "operationId": "modifyTeamBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyTeamCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Indicates the team was modified, containing the updated Team",
            "schema": {
              "$ref": "#/definitions/TeamResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Teams"
        ],
        "summary": "Delete an existing Team.",
        "operationId": "deleteTeamBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Team to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/teams/{id}/scopeduserroles": {
      "get": {
        "tags": [
          "Teams"
        ],
        "summary": "Get a list of a Team's Scoped User Roles.",
        "description": "List all the Scoped User Roles for the Team. Results will be sorted by Space Id with System Teams being sorted before Space Teams.",
        "operationId": "getTeamScopedUserRolesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Scoped User Roles",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/teams": {
      "get": {
        "tags": [
          "Teams"
        ],
        "summary": "Get a list of Teams",
        "description": "Lists all of the Teams in the system or Octopus Deploy Space (if provided). The results will be sorted alphabetically by name.",
        "operationId": "getTeams",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Team IDs, to limit the matching of Teams to those with a particular ID. Example: [\"Teams-1\", \"Teams-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Team to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Teams to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Teams",
            "schema": {
              "$ref": "#/definitions/TeamResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Teams"
        ],
        "summary": "Create a new team",
        "operationId": "createTeam",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateTeamCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/TeamResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/teams/all": {
      "get": {
        "tags": [
          "Teams"
        ],
        "summary": "Get a list of Teams",
        "description": "Lists all of the Teams in the supplied Octopus Deploy Space. The results will be sorted by name.",
        "operationId": "getAllTeams",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Teams",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TeamResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/teams/{id}": {
      "get": {
        "tags": [
          "Teams"
        ],
        "summary": "Get a Team by ID",
        "operationId": "getTeamById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the team.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Team",
            "schema": {
              "$ref": "#/definitions/TeamResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Teams"
        ],
        "summary": "Modify an existing Team",
        "description": "The Everyone Team is treated as a special case and its members and external groups may not be changed.",
        "operationId": "modifyTeam",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyTeamCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Indicates the team was modified, containing the updated Team",
            "schema": {
              "$ref": "#/definitions/TeamResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Teams"
        ],
        "summary": "Delete an existing Team.",
        "operationId": "deleteTeam",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Team to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/teams/{id}/scopeduserroles": {
      "get": {
        "tags": [
          "Teams"
        ],
        "summary": "Get a list of a Team's Scoped User Roles.",
        "description": "List all the Scoped User Roles for the Team. Results will be sorted by Space Id with System Teams being sorted before Space Teams.",
        "operationId": "getTeamScopedUserRoles",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Scoped User Roles",
            "schema": {
              "$ref": "#/definitions/ScopedUserRoleResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/telemetry/download": {
      "get": {
        "tags": [
          "Telemetry"
        ],
        "summary": "Get the latest telemetry data.",
        "operationId": "getTelemetryDownload",
        "produces": [
          "application/octet-stream",
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/telemetry/lastTask": {
      "get": {
        "tags": [
          "Telemetry"
        ],
        "summary": "Get the last telemetry task",
        "operationId": "getLastTelemetryTask",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested last Telemetry Task",
            "schema": {
              "$ref": "#/definitions/TaskResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/telemetryconfiguration": {
      "get": {
        "tags": [
          "Telemetry"
        ],
        "summary": "Get the Telemetry configuration",
        "operationId": "getTelemetryConfiguration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested Telemetry Configuration",
            "schema": {
              "$ref": "#/definitions/TelemetryConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Telemetry"
        ],
        "summary": "Update the Telemetry Configuration",
        "operationId": "modifyTelemetryConfiguration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "The desired state of the Telemetry configuration",
            "schema": {
              "$ref": "#/definitions/ModifyTelemetryConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that Telemetry Configuration was modified, containing the new configuration",
            "schema": {
              "$ref": "#/definitions/TelemetryConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tenants": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get a list of tenants",
        "description": "Lists all of the tenants in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name, and returned 30 at a time.",
        "operationId": "getTenants_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "clonedFromTenantId",
            "description": "A Tenant ID, to limit the included Tenants to those cloned from that Tenant. Example: Tenants-1",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Tenant IDs, to limit the matching of Tenants to those with a particular ID. Example: [\"Tenants-1\", \"Tenants-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "Disabled Status, to limit the set of retrieved Tenants to those with the specified disabled status.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "(Obsolete) A partial or complete name to limit the set of retrieved Tenants to. This will perform a \"contains\" style match against the supplied name or name-fragment. Left for backwards compatibility.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Tenants to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A Project ID, to limit the set of Tenants to those connected to a particular Project. Example: Projects-1",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tags",
            "description": "A set of Tenant Tags, to limit the set of retrieved Tenants to those which are tagged with the specific tags. Example: Alpha,Beta,Stable",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Tenants",
            "schema": {
              "$ref": "#/definitions/TenantResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create a new Tenant.",
        "description": "Creates a new Tenant, optionally cloning an existing tenant if the clone query string parameter is provided.",
        "operationId": "createTenant_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateTenantCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/TenantResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tenants/all": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "List all tenants",
        "description": "Lists all of the tenants in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllTenants_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "A set of Tenant IDs to retrieve Tenants for.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "Disabled Status, to limit the set of retrieved Tenants to those with the specified disabled status.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "(Obsolete) A partial or complete name to limit the set of retrieved Tenants to. This will perform a \"contains\" style match against the supplied name or name-fragment. Left for backwards compatibility.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to limit the set of retrieved Tenants to. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A Project ID, to limit the set of retrieved Tenants to those connected to a particular Project.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tags",
            "description": "A set of Tenant Tags, to limit the set of retrieved Tenants to those which are tagged with the specific tags. Example: Alpha,Beta,Stable",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Tenants",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TenantResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tenants/status": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Report back the status of multi-tenancy.",
        "description": "If multi-tenancy is enabled, \\\"Enabled\\\" will be true, otherwise it will be false.",
        "operationId": "getTenantStatus_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The status of multi-tenancy.",
            "schema": {
              "$ref": "#/definitions/MultiTenancyStatusResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tenants/tag-test": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Check tenants for matching tags",
        "operationId": "testTenantTag_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "tags",
            "description": "A list of Tenant Tags to limit the matching to.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "description": "A list of Tenant IDs to limit the matching to.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested set of Tenants with matching Tags",
            "schema": {
              "type": "object",
              "additionalProperties": {
                "$ref": "#/definitions/TagTestResult"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tenants/variables-missing": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Return a list of tenants who are missing required variables.",
        "operationId": "getTenantMissingVariables_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "environmentId",
            "description": "An Environment ID, to limit the set of inspected Tenants to those connected to a particular Environment. Example: Environments-202.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDetails",
            "description": "A switch to indicate whether missing variable details should be returned along with names. When false, each result names only the tenant, which is enough to check whether a tenant is missing anything at all.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A Project ID, to limit the set of inspected Tenants to those connected to a particular Project. Example: Projects-202.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "An ID for a Tenant. If supplied, will limit the result to variables missing for the Tenant identified by the ID. Example: Tenants-101.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "List of tenants who are missing required variables.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TenantsMissingVariablesResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tenants/{id}": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get a tenant by it's Id",
        "operationId": "getTenantById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a tenant",
            "schema": {
              "$ref": "#/definitions/TenantResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Modify an existing Tenant.",
        "operationId": "modifyTenant_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyTenantCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a Tenant has been modified, containing the updated Tenant",
            "schema": {
              "$ref": "#/definitions/TenantResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Tenants"
        ],
        "summary": "Delete an existing Tenant.",
        "operationId": "deleteTenant_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tenants/{id}/logo": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get the logo associated with the Tenant.",
        "operationId": "getTenantLogo_LegacyDefaultSpace",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to retrieve the logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Modify the logo associated with the tenant.",
        "operationId": "modifyTenantLogo_LegacyDefaultSpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to update the logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Modify the logo associated with the tenant.",
        "operationId": "modifyTenantLogoUsingPut_LegacyDefaultSpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to update the logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tenants/{id}/variables": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get variables associated with the provided tenant ID.",
        "operationId": "getVariablesByTenantId_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Tenant to retrieve variables for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Variables associated with the provided tenant ID.",
            "schema": {
              "$ref": "#/definitions/TenantVariableResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the variables associated with the tenant.",
        "operationId": "modifyVariablesByTenantId_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The variables associated with the tenant.",
            "schema": {
              "$ref": "#/definitions/TenantVariableResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the variables associated with the tenant.",
        "operationId": "modifyVariablesByTenantIdUsingPut_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The variables associated with the tenant.",
            "schema": {
              "$ref": "#/definitions/TenantVariableResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tenants/{tenantId}/commonvariables": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get the common variables associated with the tenant.",
        "operationId": "getCommonVariablesByTenantId_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "tenantId",
            "description": "The ID of the tenant to read common variable values for. Example: Tenants-101.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeMissingVariables",
            "description": "When true, the response also lists the library variable set templates the tenant is required to supply a value for but has not, along with each template's default value.",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The common variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/GetCommonVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the common variables associated with the tenant.",
        "operationId": "modifyCommonVariablesByTenantId_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyCommonVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The common variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/ModifyCommonVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the common variables associated with the tenant.",
        "operationId": "modifyCommonVariablesByTenantIdUsingPut_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyCommonVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The common variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/ModifyCommonVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tenants/{tenantId}/projectvariables": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get the project variables associated with the tenant.",
        "operationId": "getProjectVariablesByTenantId_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "tenantId",
            "description": "The ID of the tenant to read project variable values for. Example: Tenants-101.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeMissingVariables",
            "description": "When true, the response also lists the project variable templates the tenant is required to supply a value for but has not, along with each template's default value.",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The project variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/GetProjectVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the project variables associated with the tenant.",
        "operationId": "modifyProjectVariablesByTenantId_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The project variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the project variables associated with the tenant.",
        "operationId": "modifyProjectVariablesByTenantIdUsingPut_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The project variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/tenantvariables/all": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "List all of the tenant variables in the supplied Octopus Deploy Space. The results will be sorted alphabetically by id.",
        "operationId": "getAllTenantVariables_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of a project that tenants must be connected to, to be included in the result set. For matching tenants, variables from all projects are still returned.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "All of the tenant variables in the supplied Octopus Deploy Space (sorted alphabetically by id).",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TenantVariableResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tenants": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get a list of tenants",
        "description": "Lists all of the tenants in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name, and returned 30 at a time.",
        "operationId": "getTenantsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "clonedFromTenantId",
            "description": "A Tenant ID, to limit the included Tenants to those cloned from that Tenant. Example: Tenants-1",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Tenant IDs, to limit the matching of Tenants to those with a particular ID. Example: [\"Tenants-1\", \"Tenants-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "Disabled Status, to limit the set of retrieved Tenants to those with the specified disabled status.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "(Obsolete) A partial or complete name to limit the set of retrieved Tenants to. This will perform a \"contains\" style match against the supplied name or name-fragment. Left for backwards compatibility.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Tenants to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A Project ID, to limit the set of Tenants to those connected to a particular Project. Example: Projects-1",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tags",
            "description": "A set of Tenant Tags, to limit the set of retrieved Tenants to those which are tagged with the specific tags. Example: Alpha,Beta,Stable",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Tenants",
            "schema": {
              "$ref": "#/definitions/TenantResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create a new Tenant.",
        "description": "Creates a new Tenant, optionally cloning an existing tenant if the clone query string parameter is provided.",
        "operationId": "createTenantBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateTenantCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/TenantResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tenants/all": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "List all tenants",
        "description": "Lists all of the tenants in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllTenantsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A set of Tenant IDs to retrieve Tenants for.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "Disabled Status, to limit the set of retrieved Tenants to those with the specified disabled status.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "(Obsolete) A partial or complete name to limit the set of retrieved Tenants to. This will perform a \"contains\" style match against the supplied name or name-fragment. Left for backwards compatibility.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to limit the set of retrieved Tenants to. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A Project ID, to limit the set of retrieved Tenants to those connected to a particular Project.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tags",
            "description": "A set of Tenant Tags, to limit the set of retrieved Tenants to those which are tagged with the specific tags. Example: Alpha,Beta,Stable",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Tenants",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TenantResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tenants/status": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Report back the status of multi-tenancy.",
        "description": "If multi-tenancy is enabled, \\\"Enabled\\\" will be true, otherwise it will be false.",
        "operationId": "getTenantStatusBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The status of multi-tenancy.",
            "schema": {
              "$ref": "#/definitions/MultiTenancyStatusResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tenants/tag-test": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Check tenants for matching tags",
        "operationId": "testTenantTagBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tags",
            "description": "A list of Tenant Tags to limit the matching to.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "description": "A list of Tenant IDs to limit the matching to.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested set of Tenants with matching Tags",
            "schema": {
              "type": "object",
              "additionalProperties": {
                "$ref": "#/definitions/TagTestResult"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tenants/variables-missing": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Return a list of tenants who are missing required variables.",
        "operationId": "getTenantMissingVariablesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentId",
            "description": "An Environment ID, to limit the set of inspected Tenants to those connected to a particular Environment. Example: Environments-202.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDetails",
            "description": "A switch to indicate whether missing variable details should be returned along with names. When false, each result names only the tenant, which is enough to check whether a tenant is missing anything at all.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A Project ID, to limit the set of inspected Tenants to those connected to a particular Project. Example: Projects-202.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "An ID for a Tenant. If supplied, will limit the result to variables missing for the Tenant identified by the ID. Example: Tenants-101.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "List of tenants who are missing required variables.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TenantsMissingVariablesResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tenants/{id}": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get a tenant by it's Id",
        "operationId": "getTenantByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a tenant",
            "schema": {
              "$ref": "#/definitions/TenantResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Modify an existing Tenant.",
        "operationId": "modifyTenantBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyTenantCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a Tenant has been modified, containing the updated Tenant",
            "schema": {
              "$ref": "#/definitions/TenantResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Tenants"
        ],
        "summary": "Delete an existing Tenant.",
        "operationId": "deleteTenantBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tenants/{id}/logo": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get the logo associated with the Tenant.",
        "operationId": "getTenantLogoBySpace",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to retrieve the logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Modify the logo associated with the tenant.",
        "operationId": "modifyTenantLogoBySpace",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to update the logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Modify the logo associated with the tenant.",
        "operationId": "modifyTenantLogoBySpaceUsingPut",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to update the logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tenants/{id}/variables": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get variables associated with the provided tenant ID.",
        "operationId": "getVariablesByTenantIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Tenant to retrieve variables for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Variables associated with the provided tenant ID.",
            "schema": {
              "$ref": "#/definitions/TenantVariableResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the variables associated with the tenant.",
        "operationId": "modifyVariablesByTenantIdBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The variables associated with the tenant.",
            "schema": {
              "$ref": "#/definitions/TenantVariableResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the variables associated with the tenant.",
        "operationId": "modifyVariablesByTenantIdBySpaceUsingPut",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The variables associated with the tenant.",
            "schema": {
              "$ref": "#/definitions/TenantVariableResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tenants/{tenantId}/commonvariables": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get the common variables associated with the tenant.",
        "operationId": "getCommonVariablesByTenantIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "description": "The ID of the tenant to read common variable values for. Example: Tenants-101.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeMissingVariables",
            "description": "When true, the response also lists the library variable set templates the tenant is required to supply a value for but has not, along with each template's default value.",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The common variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/GetCommonVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the common variables associated with the tenant.",
        "operationId": "modifyCommonVariablesByTenantIdBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyCommonVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The common variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/ModifyCommonVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the common variables associated with the tenant.",
        "operationId": "modifyCommonVariablesByTenantIdBySpaceUsingPut",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyCommonVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The common variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/ModifyCommonVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tenants/{tenantId}/projectvariables": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get the project variables associated with the tenant.",
        "operationId": "getProjectVariablesByTenantIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "description": "The ID of the tenant to read project variable values for. Example: Tenants-101.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeMissingVariables",
            "description": "When true, the response also lists the project variable templates the tenant is required to supply a value for but has not, along with each template's default value.",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The project variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/GetProjectVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the project variables associated with the tenant.",
        "operationId": "modifyProjectVariablesByTenantIdBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The project variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the project variables associated with the tenant.",
        "operationId": "modifyProjectVariablesByTenantIdBySpaceUsingPut",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The project variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/tenantvariables/all": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "List all of the tenant variables in the supplied Octopus Deploy Space. The results will be sorted alphabetically by id.",
        "operationId": "getAllTenantVariablesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of a project that tenants must be connected to, to be included in the result set. For matching tenants, variables from all projects are still returned.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "All of the tenant variables in the supplied Octopus Deploy Space (sorted alphabetically by id).",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TenantVariableResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tenants": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get a list of tenants",
        "description": "Lists all of the tenants in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name, and returned 30 at a time.",
        "operationId": "getTenants",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "clonedFromTenantId",
            "description": "A Tenant ID, to limit the included Tenants to those cloned from that Tenant. Example: Tenants-1",
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Tenant IDs, to limit the matching of Tenants to those with a particular ID. Example: [\"Tenants-1\", \"Tenants-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "Disabled Status, to limit the set of retrieved Tenants to those with the specified disabled status.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "(Obsolete) A partial or complete name to limit the set of retrieved Tenants to. This will perform a \"contains\" style match against the supplied name or name-fragment. Left for backwards compatibility.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the set of Tenants to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A Project ID, to limit the set of Tenants to those connected to a particular Project. Example: Projects-1",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "tags",
            "description": "A set of Tenant Tags, to limit the set of retrieved Tenants to those which are tagged with the specific tags. Example: Alpha,Beta,Stable",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Tenants",
            "schema": {
              "$ref": "#/definitions/TenantResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create a new Tenant.",
        "description": "Creates a new Tenant, optionally cloning an existing tenant if the clone query string parameter is provided.",
        "operationId": "createTenant",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateTenantCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/TenantResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tenants/all": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "List all tenants",
        "description": "Lists all of the tenants in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllTenants",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A set of Tenant IDs to retrieve Tenants for.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "Disabled Status, to limit the set of retrieved Tenants to those with the specified disabled status.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "(Obsolete) A partial or complete name to limit the set of retrieved Tenants to. This will perform a \"contains\" style match against the supplied name or name-fragment. Left for backwards compatibility.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to limit the set of retrieved Tenants to. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A Project ID, to limit the set of retrieved Tenants to those connected to a particular Project.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tags",
            "description": "A set of Tenant Tags, to limit the set of retrieved Tenants to those which are tagged with the specific tags. Example: Alpha,Beta,Stable",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested list of Tenants",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TenantResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tenants/status": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Report back the status of multi-tenancy.",
        "description": "If multi-tenancy is enabled, \\\"Enabled\\\" will be true, otherwise it will be false.",
        "operationId": "getTenantStatus",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The status of multi-tenancy.",
            "schema": {
              "$ref": "#/definitions/MultiTenancyStatusResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tenants/tag-test": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Check tenants for matching tags",
        "operationId": "testTenantTag",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "tags",
            "description": "A list of Tenant Tags to limit the matching to.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "tenantIds",
            "description": "A list of Tenant IDs to limit the matching to.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "Requested set of Tenants with matching Tags",
            "schema": {
              "type": "object",
              "additionalProperties": {
                "$ref": "#/definitions/TagTestResult"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tenants/variables-missing": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Return a list of tenants who are missing required variables.",
        "operationId": "getTenantMissingVariables",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "environmentId",
            "description": "An Environment ID, to limit the set of inspected Tenants to those connected to a particular Environment. Example: Environments-202.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeDetails",
            "description": "A switch to indicate whether missing variable details should be returned along with names. When false, each result names only the tenant, which is enough to check whether a tenant is missing anything at all.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "A Project ID, to limit the set of inspected Tenants to those connected to a particular Project. Example: Projects-202.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenantId",
            "description": "An ID for a Tenant. If supplied, will limit the result to variables missing for the Tenant identified by the ID. Example: Tenants-101.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "List of tenants who are missing required variables.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TenantsMissingVariablesResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tenants/{id}": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get a tenant by it's Id",
        "operationId": "getTenantById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a tenant",
            "schema": {
              "$ref": "#/definitions/TenantResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Modify an existing Tenant.",
        "operationId": "modifyTenant",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyTenantCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a Tenant has been modified, containing the updated Tenant",
            "schema": {
              "$ref": "#/definitions/TenantResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Tenants"
        ],
        "summary": "Delete an existing Tenant.",
        "operationId": "deleteTenant",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tenants/{id}/logo": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get the logo associated with the Tenant.",
        "operationId": "getTenantLogo",
        "produces": [
          "image/png",
          "image/jpeg",
          "image/svg+xml",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to retrieve the logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "binary"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Modify the logo associated with the tenant.",
        "operationId": "modifyTenantLogo",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to update the logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Modify the logo associated with the tenant.",
        "operationId": "modifyTenantLogoUsingPut",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to update the logo for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tenants/{id}/variables": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get variables associated with the provided tenant ID.",
        "operationId": "getVariablesByTenantId",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Id of the Tenant to retrieve variables for.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Variables associated with the provided tenant ID.",
            "schema": {
              "$ref": "#/definitions/TenantVariableResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the variables associated with the tenant.",
        "operationId": "modifyVariablesByTenantId",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The variables associated with the tenant.",
            "schema": {
              "$ref": "#/definitions/TenantVariableResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the variables associated with the tenant.",
        "operationId": "modifyVariablesByTenantIdUsingPut",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Tenant to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The variables associated with the tenant.",
            "schema": {
              "$ref": "#/definitions/TenantVariableResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tenants/{tenantId}/commonvariables": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get the common variables associated with the tenant.",
        "operationId": "getCommonVariablesByTenantId",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "description": "The ID of the tenant to read common variable values for. Example: Tenants-101.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeMissingVariables",
            "description": "When true, the response also lists the library variable set templates the tenant is required to supply a value for but has not, along with each template's default value.",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The common variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/GetCommonVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the common variables associated with the tenant.",
        "operationId": "modifyCommonVariablesByTenantId",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyCommonVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The common variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/ModifyCommonVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the common variables associated with the tenant.",
        "operationId": "modifyCommonVariablesByTenantIdUsingPut",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyCommonVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The common variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/ModifyCommonVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tenants/{tenantId}/projectvariables": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "Get the project variables associated with the tenant.",
        "operationId": "getProjectVariablesByTenantId",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "description": "The ID of the tenant to read project variable values for. Example: Tenants-101.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeMissingVariables",
            "description": "When true, the response also lists the project variable templates the tenant is required to supply a value for but has not, along with each template's default value.",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The project variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/GetProjectVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the project variables associated with the tenant.",
        "operationId": "modifyProjectVariablesByTenantId",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The project variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Tenants"
        ],
        "summary": "Create or Update the project variables associated with the tenant.",
        "operationId": "modifyProjectVariablesByTenantIdUsingPut",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "tenantId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariablesByTenantIdCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The project variables associated with a tenant.",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariablesByTenantIdResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/tenantvariables/all": {
      "get": {
        "tags": [
          "Tenants"
        ],
        "summary": "List all of the tenant variables in the supplied Octopus Deploy Space. The results will be sorted alphabetically by id.",
        "operationId": "getAllTenantVariables",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectId",
            "description": "ID of a project that tenants must be connected to, to be included in the result set. For matching tenants, variables from all projects are still returned.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "All of the tenant variables in the supplied Octopus Deploy Space (sorted alphabetically by id).",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TenantVariableResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/token/v1": {
      "post": {
        "tags": [
          "TokenExchange"
        ],
        "summary": "Exchange an Oidc token for an access token that allows access to the API",
        "operationId": "exchangeOidcTokenForAccessTokenV1",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ExchangeOidcTokenForAccessTokenCommandV1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/upgradeconfiguration": {
      "get": {
        "tags": [
          "Upgrade"
        ],
        "summary": "Get information about the upgrade configuration in use by the Octopus Server.",
        "operationId": "getUpgradeConfiguration",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The current upgrade configuration",
            "schema": {
              "$ref": "#/definitions/UpgradeConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Upgrade"
        ],
        "summary": "Update the upgrade configuration used by the Octopus Server.",
        "operationId": "setUpgradeConfiguration",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/SetUpgradeConfigurationCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The updated upgrade configuration",
            "schema": {
              "$ref": "#/definitions/UpgradeConfigurationResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/{id}/permissions": {
      "get": {
        "tags": [
          "UserPermissions"
        ],
        "summary": "Get the user's permission information",
        "operationId": "getUserPermissions_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeSystem",
            "description": "Whether to include permission information from the system context",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The user's exported permissions",
            "schema": {
              "$ref": "#/definitions/UserPermissionSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/{id}/permissions/configuration": {
      "get": {
        "tags": [
          "UserPermissions"
        ],
        "summary": "Get the user's permission information",
        "operationId": "getUserPermissionConfiguration_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "apiKeyId",
            "description": "When supplied, computes the permission set as it would apply through this existing API key. The key must belong to the user.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeSystem",
            "description": "Whether to include permission information from the system context",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "previewReadOnly",
            "description": "When supplied, previews the permission set of a hypothetical new API key with the given read-only flag. Mutually exclusive with ApiKeyId.",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The user's exported permissions",
            "schema": {
              "$ref": "#/definitions/UserPermissionSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/{id}/permissions/export": {
      "get": {
        "tags": [
          "UserPermissions"
        ],
        "summary": "Get a list of permissions for the currently authenticated user.",
        "operationId": "exportUserPermissions_LegacyDefaultSpace",
        "produces": [
          "text/csv",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/users/{id}/permissions": {
      "get": {
        "tags": [
          "UserPermissions"
        ],
        "summary": "Get the user's permission information",
        "operationId": "getUserPermissionsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space to get permissions for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeSystem",
            "description": "Whether to include permission information from the system context",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The user's exported permissions",
            "schema": {
              "$ref": "#/definitions/UserPermissionSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/users/{id}/permissions/configuration": {
      "get": {
        "tags": [
          "UserPermissions"
        ],
        "summary": "Get the user's permission information",
        "operationId": "getUserPermissionConfigurationBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space to get permissions for.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "apiKeyId",
            "description": "When supplied, computes the permission set as it would apply through this existing API key. The key must belong to the user.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeSystem",
            "description": "Whether to include permission information from the system context",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "previewReadOnly",
            "description": "When supplied, previews the permission set of a hypothetical new API key with the given read-only flag. Mutually exclusive with ApiKeyId.",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The user's exported permissions",
            "schema": {
              "$ref": "#/definitions/UserPermissionSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/users/{id}/permissions/export": {
      "get": {
        "tags": [
          "UserPermissions"
        ],
        "summary": "Get a list of permissions for the currently authenticated user.",
        "operationId": "exportUserPermissionsBySpace",
        "produces": [
          "text/csv",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/users/{id}/permissions": {
      "get": {
        "tags": [
          "UserPermissions"
        ],
        "summary": "Get the user's permission information",
        "operationId": "getUserPermissions",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeSystem",
            "description": "Whether to include permission information from the system context",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The user's exported permissions",
            "schema": {
              "$ref": "#/definitions/UserPermissionSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/users/{id}/permissions/configuration": {
      "get": {
        "tags": [
          "UserPermissions"
        ],
        "summary": "Get the user's permission information",
        "operationId": "getUserPermissionConfiguration",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "apiKeyId",
            "description": "When supplied, computes the permission set as it would apply through this existing API key. The key must belong to the user.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "includeSystem",
            "description": "Whether to include permission information from the system context",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "previewReadOnly",
            "description": "When supplied, previews the permission set of a hypothetical new API key with the given read-only flag. Mutually exclusive with ApiKeyId.",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "The user's exported permissions",
            "schema": {
              "$ref": "#/definitions/UserPermissionSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/users/{id}/permissions/export": {
      "get": {
        "tags": [
          "UserPermissions"
        ],
        "summary": "Get a list of permissions for the currently authenticated user.",
        "operationId": "exportUserPermissions",
        "produces": [
          "text/csv",
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the user",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "string",
              "format": "string"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/userroles": {
      "get": {
        "tags": [
          "UserRoles"
        ],
        "summary": "Get a list of User Roles.",
        "description": "Lists all of the User Roles in the current Octopus Deploy instance. The results will be sorted alphabetically by name.",
        "operationId": "getUserRoles",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "A list of User Role IDs, to limit the result to those with a particular ID. Example: [\"UserRoles-1\", \"UserRoles-2\"]",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial name, to limit the result to those with a name that includes the partial name",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Request list of user roles.",
            "schema": {
              "$ref": "#/definitions/UserRoleResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "UserRoles"
        ],
        "summary": "Create a custom user role definition.",
        "operationId": "createUserRole",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateUserRoleCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/UserRoleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/userroles/all": {
      "get": {
        "tags": [
          "UserRoles"
        ],
        "summary": "Get a list of User Roles.",
        "description": "Lists all of the User Roles in the current Octopus Deploy instance. The results will be sorted alphabetically by name.",
        "operationId": "getAllUserRoles",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested list of user roles.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserRoleResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/userroles/{id}": {
      "get": {
        "tags": [
          "UserRoles"
        ],
        "summary": "Get a User Role by ID.",
        "operationId": "getUserRoleById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the UserRole to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested user role.",
            "schema": {
              "$ref": "#/definitions/UserRoleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "UserRoles"
        ],
        "summary": "Modify an existing User Role",
        "operationId": "modifyUserRole",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Id of the User Role to modify.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyUserRoleCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful modify operation.",
            "schema": {
              "$ref": "#/definitions/UserRoleResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "UserRoles"
        ],
        "summary": "Delete an existing User Role.",
        "operationId": "deleteUserRole",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the User Role to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "Get a list of Users.",
        "description": "Lists all of the Users in the current Octopus Deploy instance, from all Teams. The results will be sorted alphabetically by username.",
        "operationId": "getUsers",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "filter",
            "description": "Filters the Users by Username/DisplayName/EmailAddress/IdentificationToken using the specified `filter` fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "isActive",
            "description": "A filter to return only active (true) or disabled (false) users. Omit to return both.",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "isServiceAccount",
            "description": "A filter to return only service account users",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "serviceAccountType",
            "description": "A filter to return only service accounts of the specified type",
            "type": "string",
            "enum": [
              "Standard",
              "Agent"
            ]
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Users that meet the filter conditions",
            "schema": {
              "$ref": "#/definitions/UserResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Users"
        ],
        "summary": "Create a new user.",
        "operationId": "createUser",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateUserCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/UserResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/all": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "Get a list of Users.",
        "description": "Lists all the Users in the System. The results will be sorted alphabetically by `Username`.",
        "operationId": "getAllUsers",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A list of all the users",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/authentication": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "Provide the details of the enabled authentication providers and whether the current user can edit logins for the given user.",
        "operationId": "getUserAuthenticationProviders_Legacy0",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "userId",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The currently enabled authentication providers",
            "schema": {
              "$ref": "#/definitions/GetUserAuthenticationProvidersResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/authentication/{userId}": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "Provide the details of the enabled authentication providers and whether the current user can edit logins for the given user.",
        "operationId": "getUserAuthenticationProviders",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "userId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The currently enabled authentication providers",
            "schema": {
              "$ref": "#/definitions/GetUserAuthenticationProvidersResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/external-search": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "Search for users, using the authentication providers",
        "operationId": "searchExternalAuthenticationProviders",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "partialName",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The results of the external user provider search",
            "schema": {
              "$ref": "#/definitions/SearchExternalAuthenticationProvidersResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/identity-metadata": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "Get the metadata to describe the claims/fields used by authentication providers that support identities.",
        "operationId": "getUserIdentityMetadata",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The user identity metadata",
            "schema": {
              "$ref": "#/definitions/GetUserIdentityMetadataResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/login": {
      "post": {
        "tags": [
          "Users"
        ],
        "summary": "Log in.",
        "operationId": "loginUser",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/LoginUserCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The details of a successful login",
            "schema": {
              "$ref": "#/definitions/UserResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/logout": {
      "post": {
        "tags": [
          "Users"
        ],
        "description": "Logs out the current user.",
        "operationId": "LogoutUser",
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/users/me": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "Get information about the current user.",
        "operationId": "getCurrentUser",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The current user's details",
            "schema": {
              "$ref": "#/definitions/UserResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/register": {
      "post": {
        "tags": [
          "Users"
        ],
        "summary": "Register a new user and responds with an authentication cookie. Unless the first administrator user is being registered, an invitation code must be provided.",
        "operationId": "registerUser",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/RegisterUserCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/UserResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/{id}": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "Get a User by ID.",
        "operationId": "getUserById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the User to load",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The user details",
            "schema": {
              "$ref": "#/definitions/UserResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Users"
        ],
        "summary": "Modify an existing user.",
        "operationId": "modifyUser",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyUserCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The updated user",
            "schema": {
              "$ref": "#/definitions/UserResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Users"
        ],
        "summary": "Delete an existing User",
        "operationId": "deleteUser",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the user to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/users/{userId}/revoke-sessions": {
      "put": {
        "tags": [
          "Users"
        ],
        "summary": "Revoke all sessions for a user.",
        "operationId": "revokeUserSessions",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "userId",
            "description": "ID of the User to revoke",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Empty response, indicating the sessions have been revoked",
            "schema": {
              "$ref": "#/definitions/RevokeUserSessionsResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/variables/all": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get a list of Variable Sets.",
        "description": "Lists all the Variable Sets in the supplied Space.",
        "operationId": "getAllVariables_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Variable Set resource IDs used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Variable Sets",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/VariableSetResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/variables/names": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get a list of Variable names.",
        "description": "List the names of variables that can be used in deployment actions. If a project is specified, this will include variables in that project. If a project environments filter is specified, project variables which are scoped to an unspecified environment will be excluded.",
        "operationId": "getVariableNames_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "gitRef",
            "description": "GitRef for the project variables",
            "type": "string"
          },
          {
            "in": "query",
            "name": "project",
            "description": "ID of the Project",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectEnvironmentsFilter",
            "description": "ID of the Deployment Environments to filter on",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbook",
            "description": "ID of the Runbook",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Variable names",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/variables/preview": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get a Variable Set preview",
        "description": "Lists the evaluated Variables for a deployment.",
        "operationId": "getVariableSetPreview_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "action",
            "description": "ID of the Action",
            "type": "string"
          },
          {
            "in": "query",
            "name": "channel",
            "description": "ID of the Channel",
            "type": "string"
          },
          {
            "in": "query",
            "name": "environment",
            "description": "ID of the Deployment Environment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "gitRef",
            "description": "GitRef for the project variables",
            "type": "string"
          },
          {
            "in": "query",
            "name": "machine",
            "description": "ID of the Machine",
            "type": "string"
          },
          {
            "in": "query",
            "name": "project",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "role",
            "description": "Name of the Role",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbook",
            "description": "ID of the Runbook",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Variable Set Preview",
            "schema": {
              "$ref": "#/definitions/VariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/variables/{id}": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get a Variable Set by Id",
        "operationId": "getVariableSet_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Variable Set",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Variable Set",
            "schema": {
              "$ref": "#/definitions/VariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Variables"
        ],
        "summary": "Update a Variable Set",
        "operationId": "modifyVariableSet_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyVariableSetCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a variable set has been modified, containing the updated variable set",
            "schema": {
              "$ref": "#/definitions/VariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/git/migrate-variables": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Return a summary of the variables that will be migrated to Git.",
        "operationId": "convertProjectVariablesToGitSummaryBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "Id of the project to convert",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the requested Project Variables were converted to git",
            "schema": {
              "$ref": "#/definitions/ConvertProjectVariablesToGitSummaryResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Variables"
        ],
        "summary": "Convert all non-sensitive project variables to be stored in Git rather than the database.",
        "operationId": "convertProjectVariablesToGitBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ConvertProjectVariablesToGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Empty response indicating the Project Variables were converted",
            "schema": {
              "$ref": "#/definitions/ConvertProjectVariablesToGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/variables": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get variables for a project.",
        "operationId": "getProjectVariableSetInDatabaseBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Variable Set",
            "schema": {
              "$ref": "#/definitions/ProjectVariablesResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Variables"
        ],
        "summary": "Modify variables for the project",
        "operationId": "modifyProjectVariableSetInDatabaseBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariableSetInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a Project Variable Set has been modified",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariableSetInDatabaseResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/projects/{projectId}/{gitRef}/variables": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get variables for a project.",
        "operationId": "getProjectVariableSetInGitBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Variable Set",
            "schema": {
              "$ref": "#/definitions/ProjectVariablesResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Variables"
        ],
        "summary": "Modify variables for the project",
        "operationId": "modifyProjectVariableSetInGitBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariableSetInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a Project Variable Set has been modified",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariableSetInGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/variables/all": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get a list of Variable Sets.",
        "description": "Lists all the Variable Sets in the supplied Space.",
        "operationId": "getAllVariablesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Variable Set resource IDs used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Variable Sets",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/VariableSetResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/variables/names": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get a list of Variable names.",
        "description": "List the names of variables that can be used in deployment actions. If a project is specified, this will include variables in that project. If a project environments filter is specified, project variables which are scoped to an unspecified environment will be excluded.",
        "operationId": "getVariableNamesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "gitRef",
            "description": "GitRef for the project variables",
            "type": "string"
          },
          {
            "in": "query",
            "name": "project",
            "description": "ID of the Project",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectEnvironmentsFilter",
            "description": "ID of the Deployment Environments to filter on",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbook",
            "description": "ID of the Runbook",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Variable names",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/variables/preview": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get a Variable Set preview",
        "description": "Lists the evaluated Variables for a deployment.",
        "operationId": "getVariableSetPreviewBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "action",
            "description": "ID of the Action",
            "type": "string"
          },
          {
            "in": "query",
            "name": "channel",
            "description": "ID of the Channel",
            "type": "string"
          },
          {
            "in": "query",
            "name": "environment",
            "description": "ID of the Deployment Environment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "gitRef",
            "description": "GitRef for the project variables",
            "type": "string"
          },
          {
            "in": "query",
            "name": "machine",
            "description": "ID of the Machine",
            "type": "string"
          },
          {
            "in": "query",
            "name": "project",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "role",
            "description": "Name of the Role",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbook",
            "description": "ID of the Runbook",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Variable Set Preview",
            "schema": {
              "$ref": "#/definitions/VariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/variables/{id}": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get a Variable Set by Id",
        "operationId": "getVariableSetBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Variable Set",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Variable Set",
            "schema": {
              "$ref": "#/definitions/VariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Variables"
        ],
        "summary": "Update a Variable Set",
        "operationId": "modifyVariableSetBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyVariableSetCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a variable set has been modified, containing the updated variable set",
            "schema": {
              "$ref": "#/definitions/VariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/git/migrate-variables": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Return a summary of the variables that will be migrated to Git.",
        "operationId": "convertProjectVariablesToGitSummary",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "Id of the project to convert",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the requested Project Variables were converted to git",
            "schema": {
              "$ref": "#/definitions/ConvertProjectVariablesToGitSummaryResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Variables"
        ],
        "summary": "Convert all non-sensitive project variables to be stored in Git rather than the database.",
        "operationId": "convertProjectVariablesToGit",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ConvertProjectVariablesToGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Empty response indicating the Project Variables were converted",
            "schema": {
              "$ref": "#/definitions/ConvertProjectVariablesToGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/variables": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get variables for a project.",
        "operationId": "getProjectVariableSetInDatabase",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Variable Set",
            "schema": {
              "$ref": "#/definitions/ProjectVariablesResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Variables"
        ],
        "summary": "Modify variables for the project",
        "operationId": "modifyProjectVariableSetInDatabase",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariableSetInDatabaseCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a Project Variable Set has been modified",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariableSetInDatabaseResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/variables": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get variables for a project.",
        "operationId": "getProjectVariableSetInGit",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Project Variable Set",
            "schema": {
              "$ref": "#/definitions/ProjectVariablesResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Variables"
        ],
        "summary": "Modify variables for the project",
        "operationId": "modifyProjectVariableSetInGit",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "projectId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "gitRef",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariableSetInGitCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a Project Variable Set has been modified",
            "schema": {
              "$ref": "#/definitions/ModifyProjectVariableSetInGitResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/variables/all": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get a list of Variable Sets.",
        "description": "Lists all the Variable Sets in the supplied Space.",
        "operationId": "getAllVariables",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Variable Set resource IDs used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Variable Sets",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/VariableSetResource"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/variables/names": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get a list of Variable names.",
        "description": "List the names of variables that can be used in deployment actions. If a project is specified, this will include variables in that project. If a project environments filter is specified, project variables which are scoped to an unspecified environment will be excluded.",
        "operationId": "getVariableNames",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "gitRef",
            "description": "GitRef for the project variables",
            "type": "string"
          },
          {
            "in": "query",
            "name": "project",
            "description": "ID of the Project",
            "type": "string"
          },
          {
            "in": "query",
            "name": "projectEnvironmentsFilter",
            "description": "ID of the Deployment Environments to filter on",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "runbook",
            "description": "ID of the Runbook",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Variable names",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/variables/preview": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get a Variable Set preview",
        "description": "Lists the evaluated Variables for a deployment.",
        "operationId": "getVariableSetPreview",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "action",
            "description": "ID of the Action",
            "type": "string"
          },
          {
            "in": "query",
            "name": "channel",
            "description": "ID of the Channel",
            "type": "string"
          },
          {
            "in": "query",
            "name": "environment",
            "description": "ID of the Deployment Environment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "gitRef",
            "description": "GitRef for the project variables",
            "type": "string"
          },
          {
            "in": "query",
            "name": "machine",
            "description": "ID of the Machine",
            "type": "string"
          },
          {
            "in": "query",
            "name": "project",
            "description": "ID of the Project",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "role",
            "description": "Name of the Role",
            "type": "string"
          },
          {
            "in": "query",
            "name": "runbook",
            "description": "ID of the Runbook",
            "type": "string"
          },
          {
            "in": "query",
            "name": "tenant",
            "description": "ID of the Tenant",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Variable Set Preview",
            "schema": {
              "$ref": "#/definitions/VariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/variables/{id}": {
      "get": {
        "tags": [
          "Variables"
        ],
        "summary": "Get a Variable Set by Id",
        "operationId": "getVariableSet",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Variable Set",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Variable Set",
            "schema": {
              "$ref": "#/definitions/VariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Variables"
        ],
        "summary": "Update a Variable Set",
        "operationId": "modifyVariableSet",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "Gets or sets a unique identifier for this resource.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyVariableSetCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a variable set has been modified, containing the updated variable set",
            "schema": {
              "$ref": "#/definitions/VariableSetResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/configuration/versioncontrol/clear-cache": {
      "post": {
        "tags": [
          "VersionControl"
        ],
        "summary": "Clear the local Git cache.",
        "operationId": "clearGitCache",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Git Cache was cleared",
            "schema": {
              "$ref": "#/definitions/ClearGitCacheResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/configuration/versioncontrol/clear-cache/v1": {
      "post": {
        "tags": [
          "VersionControl"
        ],
        "summary": "Clear the local Git cache.",
        "operationId": "clearGitCacheV1",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Confirmation that the Git Cache was cleared",
            "schema": {
              "$ref": "#/definitions/ClearGitCacheResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/jiraservicemanagement-integration/connectivity-test": {
      "post": {
        "tags": [
          "Web"
        ],
        "consumes": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/JiraServiceManagementConnectionCheckRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/servicenow-integration/connectivity-test": {
      "post": {
        "tags": [
          "Web"
        ],
        "operationId": "_Legacy0",
        "consumes": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ServiceNowConnectionCheckRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/workerpools": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get a list of Worker Pools.",
        "description": "Lists the name and ID of of the Worker Pools in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each Worker Pool.",
        "operationId": "getWorkerPools_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "List of Worker Pool IDs which if specified, filters the result to only include Worker Pools with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Worker Pool to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Worker Pools",
            "schema": {
              "$ref": "#/definitions/WorkerPoolResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Create a new Worker Pool.",
        "operationId": "createWorkerPool_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateWorkerPoolCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/WorkerPoolResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/workerpools/all": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get a list of Worker Pools.",
        "description": "Lists the name and ID of of the Worker Pools in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each Worker Pool.",
        "operationId": "getAllWorkerPools_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "List of Worker Pool IDs which if specified, filters the result to only include Worker Pools with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of requested Worker Pools",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/WorkerPoolResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/workerpools/dynamicworkertypes": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "List the available Worker Types for the Dynamic Worker Pool",
        "description": "Returns a list of the available Worker Types for the Dynamic Worker Pool",
        "operationId": "getDynamicWorkerTypes_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The requested Dynamic Worker Types",
            "schema": {
              "$ref": "#/definitions/WorkerPoolDynamicWorkerTypesResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          },
          "500": {
            "description": "Unable to connect to the Dynamic Worker service"
          }
        }
      }
    },
    "/workerpools/sortorder": {
      "put": {
        "tags": [
          "WorkerPools"
        ],
        "description": "Takes an array of work pool IDs as the request body, uses the order of items in the array to sort the worker pools on the server. The ID of every worker pool must be specified.",
        "operationId": "sortWorkerPools_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/workerpools/summary": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "List all worker pools, including a summary of worker information.",
        "description": "Lists all worker pools, including a summary of machine information.",
        "operationId": "getWorkerPoolsSummary_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "hideEmptyWorkerPools",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "machinePartialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Worker Pool Summary",
            "schema": {
              "$ref": "#/definitions/WorkerPoolsSummaryResource"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/workerpools/supportedtypes": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get the available Worker Pool types.",
        "description": "Lists the available Worker Pool types.",
        "operationId": "getWorkerPoolSupportedTypes_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The list of Supported Worker Pool Types",
            "schema": {
              "$ref": "#/definitions/WorkerPoolSupportedTypesResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/workerpools/{id}": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get a Worker Pool by ID.",
        "operationId": "getWorkerPoolById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Worker Pool.",
            "schema": {
              "$ref": "#/definitions/WorkerPoolResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Modify an existing worker pool.",
        "description": "Updates an existing worker pool.",
        "operationId": "modifyWorkerPool_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the worker pool",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyWorkerPoolCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a Worker Pool was modified, containing the updated Worker Pool",
            "schema": {
              "$ref": "#/definitions/WorkerPoolResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Delete an existing Worker Pool.",
        "operationId": "deleteWorkerPool_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Worker Pool to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/workerpools/{id}/workers": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get a list of WorkerResources for the given WorkerPoolResource",
        "description": "Lists all of the machines that belong to the given worker pool.",
        "operationId": "getWorkersByWorkerPool_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of the WorkerPool",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 20",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Workers within a Worker Pool",
            "schema": {
              "$ref": "#/definitions/WorkerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workerpools": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get a list of Worker Pools.",
        "description": "Lists the name and ID of of the Worker Pools in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each Worker Pool.",
        "operationId": "getWorkerPoolsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Worker Pool IDs which if specified, filters the result to only include Worker Pools with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Worker Pool to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Worker Pools",
            "schema": {
              "$ref": "#/definitions/WorkerPoolResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Create a new Worker Pool.",
        "operationId": "createWorkerPoolBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateWorkerPoolCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/WorkerPoolResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workerpools/all": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get a list of Worker Pools.",
        "description": "Lists the name and ID of of the Worker Pools in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each Worker Pool.",
        "operationId": "getAllWorkerPoolsBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Worker Pool IDs which if specified, filters the result to only include Worker Pools with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of requested Worker Pools",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/WorkerPoolResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workerpools/dynamicworkertypes": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "List the available Worker Types for the Dynamic Worker Pool",
        "description": "Returns a list of the available Worker Types for the Dynamic Worker Pool",
        "operationId": "getDynamicWorkerTypesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Dynamic Worker Types",
            "schema": {
              "$ref": "#/definitions/WorkerPoolDynamicWorkerTypesResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          },
          "500": {
            "description": "Unable to connect to the Dynamic Worker service"
          }
        }
      }
    },
    "/{spaceId}/workerpools/sortorder": {
      "put": {
        "tags": [
          "WorkerPools"
        ],
        "description": "Takes an array of work pool IDs as the request body, uses the order of items in the array to sort the worker pools on the server. The ID of every worker pool must be specified.",
        "operationId": "sortWorkerPoolsBySpace",
        "consumes": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/{spaceId}/workerpools/summary": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "List all worker pools, including a summary of worker information.",
        "description": "Lists all worker pools, including a summary of machine information.",
        "operationId": "getWorkerPoolsSummaryBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "hideEmptyWorkerPools",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "machinePartialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Worker Pool Summary",
            "schema": {
              "$ref": "#/definitions/WorkerPoolsSummaryResource"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workerpools/supportedtypes": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get the available Worker Pool types.",
        "description": "Lists the available Worker Pool types.",
        "operationId": "getWorkerPoolSupportedTypesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Supported Worker Pool Types",
            "schema": {
              "$ref": "#/definitions/WorkerPoolSupportedTypesResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workerpools/{id}": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get a Worker Pool by ID.",
        "operationId": "getWorkerPoolByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Worker Pool.",
            "schema": {
              "$ref": "#/definitions/WorkerPoolResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Modify an existing worker pool.",
        "description": "Updates an existing worker pool.",
        "operationId": "modifyWorkerPoolBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the worker pool",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyWorkerPoolCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a Worker Pool was modified, containing the updated Worker Pool",
            "schema": {
              "$ref": "#/definitions/WorkerPoolResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Delete an existing Worker Pool.",
        "operationId": "deleteWorkerPoolBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Worker Pool to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workerpools/{id}/workers": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get a list of WorkerResources for the given WorkerPoolResource",
        "description": "Lists all of the machines that belong to the given worker pool.",
        "operationId": "getWorkersByWorkerPoolBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the WorkerPool",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 20",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Workers within a Worker Pool",
            "schema": {
              "$ref": "#/definitions/WorkerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workerpools": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get a list of Worker Pools.",
        "description": "Lists the name and ID of of the Worker Pools in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each Worker Pool.",
        "operationId": "getWorkerPools",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Worker Pool IDs which if specified, filters the result to only include Worker Pools with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Worker Pool to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 10",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Worker Pools",
            "schema": {
              "$ref": "#/definitions/WorkerPoolResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Create a new Worker Pool.",
        "operationId": "createWorkerPool",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateWorkerPoolCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/WorkerPoolResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workerpools/all": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get a list of Worker Pools.",
        "description": "Lists the name and ID of of the Worker Pools in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each Worker Pool.",
        "operationId": "getAllWorkerPools",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Worker Pool IDs which if specified, filters the result to only include Worker Pools with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of requested Worker Pools",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/WorkerPoolResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workerpools/dynamicworkertypes": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "List the available Worker Types for the Dynamic Worker Pool",
        "description": "Returns a list of the available Worker Types for the Dynamic Worker Pool",
        "operationId": "getDynamicWorkerTypes",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Dynamic Worker Types",
            "schema": {
              "$ref": "#/definitions/WorkerPoolDynamicWorkerTypesResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          },
          "500": {
            "description": "Unable to connect to the Dynamic Worker service"
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workerpools/sortorder": {
      "put": {
        "tags": [
          "WorkerPools"
        ],
        "description": "Takes an array of work pool IDs as the request body, uses the order of items in the array to sort the worker pools on the server. The ID of every worker pool must be specified.",
        "operationId": "sortWorkerPools",
        "consumes": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workerpools/summary": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "List all worker pools, including a summary of worker information.",
        "description": "Lists all worker pools, including a summary of machine information.",
        "operationId": "getWorkerPoolsSummary",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "hideEmptyWorkerPools",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "machinePartialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Worker Pool Summary",
            "schema": {
              "$ref": "#/definitions/WorkerPoolsSummaryResource"
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workerpools/supportedtypes": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get the available Worker Pool types.",
        "description": "Lists the available Worker Pool types.",
        "operationId": "getWorkerPoolSupportedTypes",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of Supported Worker Pool Types",
            "schema": {
              "$ref": "#/definitions/WorkerPoolSupportedTypesResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workerpools/{id}": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get a Worker Pool by ID.",
        "operationId": "getWorkerPoolById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Worker Pool.",
            "schema": {
              "$ref": "#/definitions/WorkerPoolResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Modify an existing worker pool.",
        "description": "Updates an existing worker pool.",
        "operationId": "modifyWorkerPool",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the worker pool",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyWorkerPoolCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Confirms that a Worker Pool was modified, containing the updated Worker Pool",
            "schema": {
              "$ref": "#/definitions/WorkerPoolResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Delete an existing Worker Pool.",
        "operationId": "deleteWorkerPool",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the Worker Pool to delete.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workerpools/{id}/workers": {
      "get": {
        "tags": [
          "WorkerPools"
        ],
        "summary": "Get a list of WorkerResources for the given WorkerPoolResource",
        "description": "Lists all of the machines that belong to the given worker pool.",
        "operationId": "getWorkersByWorkerPool",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "ID of the WorkerPool",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "deploymentTargetTypes",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "type": "string"
          },
          {
            "in": "query",
            "name": "shellNames",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 20",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Workers within a Worker Pool",
            "schema": {
              "$ref": "#/definitions/WorkerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/workers": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getWorkers_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "commStyles",
            "description": "List of communication styles which if specified, filters the result to only include Workers with matching communication styles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "description": "List of health statuses which if specified, filters the result to only include Deployment Targets with matching health statuses.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Worker IDs which if specified, filters the result to only include Workers with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "A filter to return only disabled/enabled Workers",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Worker to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "description": "List of operating system names which if specified, filters the result to only include Workers with matching operating systems.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "shellNames",
            "description": "List of shell names which if specified, filters the result to only include Workers with matching shells.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "workerPoolIds",
            "description": "List of Worker Pool IDs which if specified, filters the result to only include Workers belonging to these Worker Pools.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of Workers",
            "schema": {
              "$ref": "#/definitions/WorkerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Workers"
        ],
        "summary": "Create a new worker",
        "operationId": "createWorker_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateWorkerCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/WorkerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/workers/all": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get a list of Workers.",
        "description": "Lists all of the Workers in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllWorkers_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Worker resource IDs used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "thumbprint",
            "description": "A thumbprint used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Workers",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/WorkerResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/workers/discover": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Interrogate a machine for communication details so that it may be added to the installation.",
        "operationId": "discoverWorker_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "host",
            "description": "The hostname of the machine to discover",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "port",
            "description": "The port of the machine to discover",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "proxyId",
            "description": "The ID of the proxy to go through",
            "type": "string"
          },
          {
            "in": "query",
            "name": "type",
            "description": "The type of endpoint on the machine",
            "type": "string",
            "enum": [
              "TentaclePassive",
              "TentacleActive",
              "Ssh"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The worker which was discovered",
            "schema": {
              "$ref": "#/definitions/WorkerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/workers/operatingsystem/names/all": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get all operating system names for workers. The result will be a string array.",
        "operationId": "getAllWorkerOperatingSystemNames_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The operating system names for workers.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/workers/operatingsystem/shells/all": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get all operating system shell names for workers. The result will be a string array.",
        "operationId": "getAllWorkerOperatingSystemShellNames_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "The operating system shell names for workers.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/workers/v2": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getWorkersV2_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "commStyles",
            "description": "List of communication styles which if specified, filters the result to only include Workers with matching communication styles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "description": "List of health statuses which if specified, filters the result to only include Workers with matching health statuses.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Worker IDs which if specified, filters the result to only include Workers with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "A filter to return only disabled/enabled Workers",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Worker to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "description": "List of operating system names which if specified, filters the result to only include Workers with matching operating systems.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "shellNames",
            "description": "List of shell names which if specified, filters the result to only include Workers with matching shells.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "workerPoolIds",
            "description": "List of Worker Pool IDs which if specified, filters the result to only include Workers belonging to these Worker Pools.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of alphabetically sorted workers that matched the request.",
            "schema": {
              "$ref": "#/definitions/GetWorkersResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/workers/{id}": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get a Worker by ID",
        "operationId": "getWorkerById_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Worker to retrieve",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Return the Worker Resource",
            "schema": {
              "$ref": "#/definitions/WorkerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Workers"
        ],
        "summary": "Modify an existing worker machine.",
        "operationId": "modifyWorker_LegacyDefaultSpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the worker",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyWorkerCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified worker",
            "schema": {
              "$ref": "#/definitions/WorkerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Workers"
        ],
        "summary": "Delete an existing Worker.",
        "operationId": "deleteWorker_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Worker to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/workers/{id}/connection": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get the status of the network connection between the Octopus server and a worker.",
        "operationId": "getWorkerConnectionStatus_LegacyDefaultSpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the worker",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The connection status of the worker",
            "schema": {
              "$ref": "#/definitions/MachineConnectionStatus"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workers": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getWorkersBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "description": "List of communication styles which if specified, filters the result to only include Workers with matching communication styles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "description": "List of health statuses which if specified, filters the result to only include Deployment Targets with matching health statuses.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Worker IDs which if specified, filters the result to only include Workers with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "A filter to return only disabled/enabled Workers",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Worker to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "description": "List of operating system names which if specified, filters the result to only include Workers with matching operating systems.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "shellNames",
            "description": "List of shell names which if specified, filters the result to only include Workers with matching shells.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "workerPoolIds",
            "description": "List of Worker Pool IDs which if specified, filters the result to only include Workers belonging to these Worker Pools.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of Workers",
            "schema": {
              "$ref": "#/definitions/WorkerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Workers"
        ],
        "summary": "Create a new worker",
        "operationId": "createWorkerBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateWorkerCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/WorkerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workers/all": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get a list of Workers.",
        "description": "Lists all of the Workers in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllWorkersBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Worker resource IDs used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "thumbprint",
            "description": "A thumbprint used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Workers",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/WorkerResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workers/discover": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Interrogate a machine for communication details so that it may be added to the installation.",
        "operationId": "discoverWorkerBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "host",
            "description": "The hostname of the machine to discover",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "port",
            "description": "The port of the machine to discover",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "proxyId",
            "description": "The ID of the proxy to go through",
            "type": "string"
          },
          {
            "in": "query",
            "name": "type",
            "description": "The type of endpoint on the machine",
            "type": "string",
            "enum": [
              "TentaclePassive",
              "TentacleActive",
              "Ssh"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The worker which was discovered",
            "schema": {
              "$ref": "#/definitions/WorkerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workers/operatingsystem/names/all": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get all operating system names for workers. The result will be a string array.",
        "operationId": "getAllWorkerOperatingSystemNamesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The operating system names for workers.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workers/operatingsystem/shells/all": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get all operating system shell names for workers. The result will be a string array.",
        "operationId": "getAllWorkerOperatingSystemShellNamesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The operating system shell names for workers.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workers/v2": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getWorkersV2BySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "description": "List of communication styles which if specified, filters the result to only include Workers with matching communication styles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "description": "List of health statuses which if specified, filters the result to only include Workers with matching health statuses.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Worker IDs which if specified, filters the result to only include Workers with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "A filter to return only disabled/enabled Workers",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Worker to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "description": "List of operating system names which if specified, filters the result to only include Workers with matching operating systems.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "shellNames",
            "description": "List of shell names which if specified, filters the result to only include Workers with matching shells.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "workerPoolIds",
            "description": "List of Worker Pool IDs which if specified, filters the result to only include Workers belonging to these Worker Pools.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of alphabetically sorted workers that matched the request.",
            "schema": {
              "$ref": "#/definitions/GetWorkersResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workers/{id}": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get a Worker by ID",
        "operationId": "getWorkerByIdBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Worker to retrieve",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Return the Worker Resource",
            "schema": {
              "$ref": "#/definitions/WorkerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Workers"
        ],
        "summary": "Modify an existing worker machine.",
        "operationId": "modifyWorkerBySpace",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the worker",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyWorkerCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified worker",
            "schema": {
              "$ref": "#/definitions/WorkerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Workers"
        ],
        "summary": "Delete an existing Worker.",
        "operationId": "deleteWorkerBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Worker to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workers/{id}/connection": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get the status of the network connection between the Octopus server and a worker.",
        "operationId": "getWorkerConnectionStatusBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The ID of the space containing the resource(s).",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the worker",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The connection status of the worker",
            "schema": {
              "$ref": "#/definitions/MachineConnectionStatus"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workers": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getWorkers",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "description": "List of communication styles which if specified, filters the result to only include Workers with matching communication styles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "description": "List of health statuses which if specified, filters the result to only include Deployment Targets with matching health statuses.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Worker IDs which if specified, filters the result to only include Workers with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "A filter to return only disabled/enabled Workers",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Worker to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "description": "List of operating system names which if specified, filters the result to only include Workers with matching operating systems.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "shellNames",
            "description": "List of shell names which if specified, filters the result to only include Workers with matching shells.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "workerPoolIds",
            "description": "List of Worker Pool IDs which if specified, filters the result to only include Workers belonging to these Worker Pools.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of Workers",
            "schema": {
              "$ref": "#/definitions/WorkerResourceCollection"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "post": {
        "tags": [
          "Workers"
        ],
        "summary": "Create a new worker",
        "operationId": "createWorker",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CreateWorkerCommand"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/WorkerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workers/all": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get a list of Workers.",
        "description": "Lists all of the Workers in the supplied Space. The results will be sorted alphabetically by name.",
        "operationId": "getAllWorkers",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "A list of Worker resource IDs used to filter a query.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "thumbprint",
            "description": "A thumbprint used to filter a query.",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested list of Workers",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/WorkerResource"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workers/discover": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Interrogate a machine for communication details so that it may be added to the installation.",
        "operationId": "discoverWorker",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "host",
            "description": "The hostname of the machine to discover",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "port",
            "description": "The port of the machine to discover",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "proxyId",
            "description": "The ID of the proxy to go through",
            "type": "string"
          },
          {
            "in": "query",
            "name": "type",
            "description": "The type of endpoint on the machine",
            "type": "string",
            "enum": [
              "TentaclePassive",
              "TentacleActive",
              "Ssh"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The worker which was discovered",
            "schema": {
              "$ref": "#/definitions/WorkerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workers/operatingsystem/names/all": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get all operating system names for workers. The result will be a string array.",
        "operationId": "getAllWorkerOperatingSystemNames",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The operating system names for workers.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workers/operatingsystem/shells/all": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get all operating system shell names for workers. The result will be a string array.",
        "operationId": "getAllWorkerOperatingSystemShellNames",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The operating system shell names for workers.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "304": {
            "description": "Not Modified"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workers/v2": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.",
        "operationId": "getWorkersV2",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "commStyles",
            "description": "List of communication styles which if specified, filters the result to only include Workers with matching communication styles.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "healthStatuses",
            "description": "List of health statuses which if specified, filters the result to only include Workers with matching health statuses.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "ids",
            "description": "List of Worker IDs which if specified, filters the result to only include Workers with matching IDs.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "isDisabled",
            "description": "A filter to return only disabled/enabled Workers",
            "type": "boolean"
          },
          {
            "in": "query",
            "name": "name",
            "description": "The exact name of a Worker to be matched",
            "type": "string"
          },
          {
            "in": "query",
            "name": "operatingSystemNames",
            "description": "List of operating system names which if specified, filters the result to only include Workers with matching operating systems.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "partialName",
            "description": "A partial or complete name to search on. This will perform a \"contains\" style match against the supplied name or name-fragment",
            "type": "string"
          },
          {
            "in": "query",
            "name": "shellNames",
            "description": "List of shell names which if specified, filters the result to only include Workers with matching shells.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip. Defaults to zero",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take. Defaults to 30",
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "workerPoolIds",
            "description": "List of Worker Pool IDs which if specified, filters the result to only include Workers belonging to these Worker Pools.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of alphabetically sorted workers that matched the request.",
            "schema": {
              "$ref": "#/definitions/GetWorkersResponseV2"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workers/{id}": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get a Worker by ID",
        "operationId": "getWorkerById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Worker to retrieve",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Return the Worker Resource",
            "schema": {
              "$ref": "#/definitions/WorkerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "put": {
        "tags": [
          "Workers"
        ],
        "summary": "Modify an existing worker machine.",
        "operationId": "modifyWorker",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the worker",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/ModifyWorkerCommand"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The modified worker",
            "schema": {
              "$ref": "#/definitions/WorkerResource"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      },
      "delete": {
        "tags": [
          "Workers"
        ],
        "summary": "Delete an existing Worker.",
        "operationId": "deleteWorker",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Worker to delete",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workers/{id}/connection": {
      "get": {
        "tags": [
          "Workers"
        ],
        "summary": "Get the status of the network connection between the Octopus server and a worker.",
        "operationId": "getWorkerConnectionStatus",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the worker",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The connection status of the worker",
            "schema": {
              "$ref": "#/definitions/MachineConnectionStatus"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/{spaceId}/workertaskleases": {
      "get": {
        "tags": [
          "WorkerTaskLeases"
        ],
        "summary": "Get WorkerTaskLeases",
        "description": "Gets a paginated set of WorkerTaskLeases.",
        "operationId": "getWorkerTaskLeasesBySpace",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceId",
            "description": "The id of the space for the WorkerTaskLease.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Rseponse to getting set of WorkerTaskLeases",
            "schema": {
              "$ref": "#/definitions/GetWorkerTaskLeasesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    },
    "/spaces/{spaceIdentifier}/workertaskleases": {
      "get": {
        "tags": [
          "WorkerTaskLeases"
        ],
        "summary": "Get WorkerTaskLeases",
        "description": "Gets a paginated set of WorkerTaskLeases.",
        "operationId": "getWorkerTaskLeases",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "spaceIdentifier",
            "description": "Identifier (ID or slug) of the space",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "skip",
            "description": "Number of items to skip",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          },
          {
            "in": "query",
            "name": "take",
            "description": "Number of items to take",
            "required": true,
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Rseponse to getting set of WorkerTaskLeases",
            "schema": {
              "$ref": "#/definitions/GetWorkerTaskLeasesResponse"
            }
          },
          "400": {
            "description": "Bad request. Either the payload was not structurally valid or business rules did not permit the operation.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Not found. One or more of the entities involved in the operation was not found."
          }
        }
      }
    }
  },
  "definitions": {
    "AccountDetailsResource": {
      "type": "object",
      "properties": {
        "AccountType": {
          "type": "string",
          "readOnly": true
        }
      },
      "additionalProperties": false
    },
    "AccountResource": {
      "type": "object",
      "properties": {
        "AccountType": {
          "type": "string",
          "enum": [
            "AmazonWebServicesAccount",
            "AmazonWebServicesOidcAccount",
            "AzureOidc",
            "AzureServicePrincipal",
            "AzureSubscription",
            "GenericOidcAccount",
            "GoogleCloudAccount",
            "GoogleCloudOidcAccount",
            "None",
            "SshKeyPair",
            "Token",
            "UsernamePassword"
          ],
          "readOnly": true
        },
        "Description": {
          "type": "string"
        },
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantedDeploymentParticipation": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "TenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "AccountResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/AccountResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "AccountUsageResource": {
      "type": "object",
      "properties": {
        "CommonTenantVariables": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CommonTenantVariableUsage"
          }
        },
        "DeploymentProcesses": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/StepUsage"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LibraryVariableSets": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/LibraryVariableSetUsageEntry"
          }
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectTenantVariables": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ProjectTenantVariableUsage"
          }
        },
        "ProjectVariableSets": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ProjectVariableSetUsage"
          }
        },
        "Releases": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseUsage"
          }
        },
        "RunbookProcesses": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookStepUsage"
          }
        },
        "RunbookSnapshots": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookSnapshotUsage"
          }
        },
        "Targets": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TargetUsageEntry"
          }
        }
      },
      "additionalProperties": false
    },
    "ActionsUpdateProcessResource": {
      "type": "object",
      "required": [
        "ActionIds",
        "ProcessId",
        "ProcessType"
      ],
      "properties": {
        "ActionIds": {
          "type": "array",
          "description": "The IDs of the actions to update.",
          "items": {
            "type": "string"
          }
        },
        "GitRef": {
          "type": "string",
          "description": "The Git reference for the action to update."
        },
        "ProcessId": {
          "type": "string",
          "description": "The ID of the deployment process which contains the action(s) to update.",
          "minLength": 1
        },
        "ProcessType": {
          "type": "string",
          "description": "The process type of the deployment process containing the action(s) to update.",
          "enum": [
            "Deployment",
            "Runbook"
          ]
        },
        "ProjectId": {
          "type": "string",
          "description": "The Project Id for the action to update."
        }
      },
      "additionalProperties": false
    },
    "ActionTemplateCategoryResource": {
      "type": "object",
      "properties": {
        "DisplayOrder": {
          "type": "integer",
          "format": "int32"
        },
        "Id": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ActionTemplateParameterResource": {
      "type": "object",
      "properties": {
        "DefaultValue": {
          "$ref": "#/definitions/PropertyValueResource"
        },
        "DisplaySettings": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "HelpText": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "Label": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ActionTemplateResource": {
      "type": "object",
      "required": [
        "ActionType",
        "Name"
      ],
      "properties": {
        "ActionType": {
          "type": "string",
          "minLength": 1
        },
        "CommunityActionTemplateId": {
          "type": "string"
        },
        "Description": {
          "type": "string"
        },
        "GitDependencies": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitDependencyResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Packages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PackageReferenceResource"
          }
        },
        "Parameters": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          },
          "readOnly": true
        },
        "Properties": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/PropertyValueResource"
          },
          "readOnly": true
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ActionTemplateResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionTemplateResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ActionTemplateSearchResource": {
      "type": "object",
      "properties": {
        "Author": {
          "type": "string"
        },
        "Categories": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Category": {
          "type": "string"
        },
        "CommunityActionTemplateId": {
          "type": "string"
        },
        "Description": {
          "type": "string"
        },
        "Features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "HasUpdate": {
          "type": "boolean"
        },
        "Id": {
          "type": "string"
        },
        "IsBuiltIn": {
          "type": "boolean"
        },
        "IsInstalled": {
          "type": "boolean"
        },
        "Keywords": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "Prerelease": {
          "type": "boolean"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Type": {
          "type": "string"
        },
        "Version": {
          "type": "string"
        },
        "Website": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ActionTemplateUsageResource": {
      "type": "object",
      "required": [
        "ActionId",
        "ActionName",
        "ActionTemplateId",
        "ProcessId",
        "ProjectId",
        "ProjectName",
        "ProjectSlug",
        "StepId",
        "StepName"
      ],
      "properties": {
        "ActionId": {
          "type": "string",
          "minLength": 1
        },
        "ActionName": {
          "type": "string",
          "minLength": 1
        },
        "ActionTemplateId": {
          "type": "string",
          "minLength": 1
        },
        "Branch": {
          "type": "string"
        },
        "DeploymentProcessId": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProcessId": {
          "type": "string",
          "minLength": 1
        },
        "ProcessType": {
          "type": "string",
          "enum": [
            "Deployment",
            "Runbook"
          ]
        },
        "ProjectId": {
          "type": "string",
          "minLength": 1
        },
        "ProjectName": {
          "type": "string",
          "minLength": 1
        },
        "ProjectSlug": {
          "type": "string",
          "minLength": 1
        },
        "Release": {
          "type": "string"
        },
        "RunbookId": {
          "type": "string"
        },
        "RunbookName": {
          "type": "string"
        },
        "StepId": {
          "type": "string",
          "minLength": 1
        },
        "StepName": {
          "type": "string",
          "minLength": 1
        },
        "Version": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ActionUpdateRemovedPackageUsage": {
      "type": "object",
      "properties": {
        "PackageReference": {
          "type": "string"
        },
        "UsedBy": {
          "type": "string",
          "enum": [
            "ProjectVersionStrategy",
            "ProjectReleaseCreationStrategy",
            "ChannelRule"
          ]
        },
        "UsedById": {
          "type": "string"
        },
        "UsedByName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ActionUpdateResultResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ManualMergeRequiredReasonsByPropertyName": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "NamesOfNewParametersMissingDefaultValue": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Outcome": {
          "type": "string",
          "enum": [
            "Success",
            "ManualMergeRequired",
            "DefaultParamterValueMissing",
            "RemovedPackageInUse"
          ]
        },
        "RemovedPackageUsages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionUpdateRemovedPackageUsage"
          }
        }
      },
      "additionalProperties": false
    },
    "ActivatePendingSigningKeyResponseV1": {
      "type": "object",
      "additionalProperties": false
    },
    "ActivityLogElement": {
      "type": "object",
      "properties": {
        "Category": {
          "type": "string"
        },
        "Detail": {
          "type": "string"
        },
        "GapLastNumber": {
          "type": "integer",
          "format": "int32"
        },
        "MessageText": {
          "type": "string"
        },
        "Number": {
          "type": "integer",
          "format": "int32"
        },
        "OccurredAt": {
          "type": "string",
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "ActivityLogEntry": {
      "type": "object",
      "properties": {
        "Category": {
          "type": "string",
          "enum": [
            "Trace",
            "Verbose",
            "Info",
            "Wait",
            "Highlight",
            "Gap",
            "Alert",
            "Warning",
            "Error",
            "Fatal",
            "Planned",
            "Updated",
            "Finished",
            "Abandoned",
            "Retry"
          ]
        },
        "Detail": {
          "type": "string"
        },
        "GapLastNumber": {
          "type": "integer",
          "format": "int32"
        },
        "MessageText": {
          "type": "string"
        },
        "Number": {
          "type": "integer",
          "format": "int32"
        },
        "OccurredAt": {
          "type": "string",
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "ActivityLogTreeNode": {
      "type": "object",
      "properties": {
        "Children": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActivityLogTreeNode"
          },
          "readOnly": true
        },
        "Ended": {
          "type": "string",
          "format": "date-time"
        },
        "Id": {
          "type": "string",
          "example": "0c5a872485ac4b10857939a92d082e67"
        },
        "LogElements": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActivityLogEntry"
          },
          "readOnly": true
        },
        "Name": {
          "type": "string"
        },
        "ProgressMessage": {
          "type": "string"
        },
        "ProgressPercentage": {
          "type": "integer",
          "format": "int32"
        },
        "ShowAtSummaryLevel": {
          "type": "boolean",
          "readOnly": true
        },
        "Started": {
          "type": "string",
          "format": "date-time"
        },
        "Status": {
          "type": "string",
          "enum": [
            "Pending",
            "Running",
            "Success",
            "Failed",
            "Skipped",
            "SuccessWithWarning",
            "Canceled"
          ]
        }
      },
      "additionalProperties": false
    },
    "AddConnectionAgentCredentialCommand": {
      "type": "object",
      "required": [
        "ConnectionAgentName",
        "CredentialName",
        "CredentialValue"
      ],
      "properties": {
        "ConnectionAgentName": {
          "type": "string",
          "description": "The Connection Agent Name"
        },
        "CredentialName": {
          "type": "string",
          "description": "The friendly name of the credential to add"
        },
        "CredentialValue": {
          "type": "string",
          "description": "The public key to add",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "AddSshKnownHostsCommand": {
      "type": "object",
      "required": [
        "KnownHostEntries"
      ],
      "properties": {
        "KnownHostEntries": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "AddSshKnownHostsResponse": {
      "type": "object",
      "required": [
        "AddedResources"
      ],
      "properties": {
        "AddedResources": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SshKnownHostResource"
          }
        }
      },
      "additionalProperties": false
    },
    "ApiKeyCreatedResource": {
      "type": "object",
      "required": [
        "ActorType",
        "ApiKey",
        "Created",
        "IsLastUsedTimestampKnown",
        "UserId"
      ],
      "properties": {
        "ActorType": {
          "type": "string",
          "enum": [
            "User",
            "AiAgent"
          ]
        },
        "ApiKey": {
          "type": "string",
          "minLength": 1
        },
        "Created": {
          "type": "string",
          "format": "date-time"
        },
        "Expires": {
          "type": "string",
          "format": "date-time"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsLastUsedTimestampKnown": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastUsedTimeStamp": {
          "type": "string",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Purpose": {
          "type": "string"
        },
        "UserId": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ApiKeyResource": {
      "type": "object",
      "required": [
        "AccessLevel",
        "ActorType",
        "ApiKey",
        "Created",
        "IsLastUsedTimestampKnown",
        "UserId"
      ],
      "properties": {
        "AccessLevel": {
          "type": "string",
          "description": "The access level this API key grants.",
          "enum": [
            "FullAccess",
            "ReadOnly",
            "Custom"
          ]
        },
        "ActorType": {
          "type": "string",
          "enum": [
            "User",
            "AiAgent"
          ]
        },
        "ApiKey": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "Created": {
          "type": "string",
          "format": "date-time"
        },
        "Expires": {
          "type": "string",
          "format": "date-time"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsLastUsedTimestampKnown": {
          "type": "boolean",
          "description": "Whether the API key's last-used time is being tracked. False for keys that predate last-used tracking, whose usage history is unknown. When true, a null LastUsedTimeStamp means the key has never been used."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastUsedTimeStamp": {
          "type": "string",
          "description": "The date and time (UTC) the API key was last used to authenticate; null if it has never been used.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Purpose": {
          "type": "string"
        },
        "UserId": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ApiKeyResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ApiKeyResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ApprovalResource": {
      "type": "object",
      "properties": {
        "ApproverDisplayName": {
          "type": "string"
        },
        "ApproverEmailAddress": {
          "type": "string"
        },
        "ApproverUsername": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "Notes": {
          "type": "string"
        },
        "ServerTaskApprovalId": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Status": {
          "type": "string"
        },
        "UserId": {
          "type": "string",
          "example": "Users-1"
        }
      },
      "additionalProperties": false
    },
    "ApprovalRuleIdScopeResource": {
      "type": "object",
      "required": [
        "EnvironmentIds",
        "ProjectId"
      ],
      "properties": {
        "EnvironmentIds": {
          "type": "array",
          "description": "IDs of Environments to include in the scope",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Id": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "description": "ID of Project to include in the scope",
          "example": "Projects-1"
        }
      },
      "additionalProperties": false
    },
    "ApprovalRuleResource": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "AllowSelfApproval": {
          "type": "boolean"
        },
        "ApprovingTeamIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Teams-1",
            "..."
          ]
        },
        "ApprovingUserIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Users-1",
            "..."
          ]
        },
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "IdScopes": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ApprovalRuleIdScopeResource"
          }
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "MinimumApproversRequired": {
          "type": "integer",
          "format": "int32"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ScopingStrategy": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TagScopes": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ApprovalRuleTagScopeResource"
          }
        },
        "TenantApprovalStrategy": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ApprovalRuleResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ApprovalRuleResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ApprovalRuleTagScopeResource": {
      "type": "object",
      "required": [
        "EnvironmentTags",
        "ProjectTags"
      ],
      "properties": {
        "EnvironmentTags": {
          "type": "array",
          "description": "Canonical IDs or Names of Environment tags to include in the scope",
          "items": {
            "type": "string"
          }
        },
        "Id": {
          "type": "string"
        },
        "ProjectTags": {
          "type": "array",
          "description": "Canonical IDs or Names of Project tags to include in the scope",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "ArchiveCertificateResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ArchivedEventFileResource": {
      "type": "object",
      "properties": {
        "CreatedDate": {
          "type": "string",
          "format": "date-time"
        },
        "FileBytes": {
          "type": "number",
          "format": "double"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ModifiedDate": {
          "type": "string",
          "format": "date-time"
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ArchivedEventFileResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ArchivedEventFileResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ArchivePlatformHubCertificateResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ArtifactResource": {
      "type": "object",
      "required": [
        "Filename"
      ],
      "properties": {
        "Created": {
          "type": "string",
          "description": "Gets or sets the time at which the artifact was created.",
          "format": "date-time"
        },
        "Filename": {
          "type": "string",
          "description": "Gets or sets the filename of the Artifact to create",
          "minLength": 1,
          "example": "Performance Test Results.csv"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "LogCorrelationId": {
          "type": "string",
          "description": "Gets the correlationId of the log block in which the artifact was captured",
          "example": "0c5a872485ac4b10857939a92d082e67"
        },
        "ServerTaskId": {
          "type": "string",
          "description": "Gets or sets the server task with which this artifact is associated."
        },
        "Source": {
          "type": "string",
          "description": "Gets or sets a short summary of the source of this attachment. This will typically be the name of a step/machine, or \"Uploaded by [username]\" if the attachment was uploaded by a person."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ArtifactResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ArtifactResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "AuditStreamConfigurationResource": {
      "type": "object",
      "properties": {
        "Active": {
          "type": "boolean"
        },
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "StreamConfigurationResource": {
          "$ref": "#/definitions/IAuditStreamConfigurationResource"
        }
      },
      "additionalProperties": false
    },
    "AuthenticationProviderElement": {
      "type": "object",
      "properties": {
        "CSSLinks": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "DisplayName": {
          "type": "string"
        },
        "FormsLoginEnabled": {
          "type": "boolean"
        },
        "IdentityType": {
          "type": "string",
          "enum": [
            "Guest",
            "UsernamePassword",
            "ActiveDirectory",
            "OAuth"
          ]
        },
        "JavascriptLinks": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "AuthenticationProviderThatSupportsGroups": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "readOnly": true
        },
        "IsRoleBased": {
          "type": "boolean"
        },
        "LookupUri": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "SupportsGroupLookup": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "AuthenticationResource": {
      "type": "object",
      "properties": {
        "AnyAuthenticationProvidersSupportPasswordManagement": {
          "type": "boolean"
        },
        "ApiKeyDefaultExpiryDays": {
          "type": "integer",
          "format": "int32"
        },
        "ApiKeyMaxExpiryDays": {
          "type": "integer",
          "format": "int32"
        },
        "AuthenticationProviders": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/AuthenticationProviderElement"
          }
        },
        "AutoLoginEnabled": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "OctopusIdDynamicRegistrationPending": {
          "type": "boolean"
        },
        "RememberMeEnabled": {
          "type": "boolean"
        },
        "UserApiKeysEnabled": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "AuthorizeGitHubAppCommand": {
      "type": "object",
      "required": [
        "RedirectUri"
      ],
      "properties": {
        "RedirectUri": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "AuthorizeGitHubAppResponse": {
      "type": "object",
      "required": [
        "AuthorizeUri"
      ],
      "properties": {
        "AuthorizeUri": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "AutoDeployReleaseOverrideResource": {
      "type": "object",
      "properties": {
        "EnvironmentId": {
          "type": "string"
        },
        "ReleaseId": {
          "type": "string"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        }
      },
      "additionalProperties": false
    },
    "AutomaticDeprovisioningRuleResource": {
      "type": "object",
      "properties": {
        "ExpiryDays": {
          "type": "integer",
          "format": "int32"
        },
        "ExpiryHours": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "BaseEnvironmentV2Resource": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "Slug",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "description": "Gets or sets a short description of this environment that can be used to explain the purpose of the environment to other users. This field may contain markdown."
        },
        "EnvironmentTags": {
          "type": "array",
          "description": "List of tags assigned to this environment",
          "items": {
            "type": "string"
          }
        },
        "Id": {
          "type": "string",
          "example": "Environments-1"
        },
        "Name": {
          "type": "string",
          "description": "Gets or sets the name of this environment. This should be short, preferably 5-20 characters.",
          "minLength": 1
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Type": {
          "type": "string",
          "readOnly": true
        }
      },
      "additionalProperties": false
    },
    "BaseEnvironmentV2ResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/BaseEnvironmentV2Resource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "BeginContainerLogsSessionCommand": {
      "type": "object",
      "required": [
        "ContainerName",
        "DesiredOrKubernetesMonitoredResourceId",
        "EnvironmentId",
        "MachineId",
        "PodName",
        "ProjectId",
        "ShowPreviousContainer",
        "SpaceId"
      ],
      "properties": {
        "ContainerName": {
          "type": "string",
          "minLength": 1
        },
        "DesiredOrKubernetesMonitoredResourceId": {
          "type": "string",
          "minLength": 1
        },
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "MachineId": {
          "type": "string",
          "example": "Machines-1"
        },
        "PodName": {
          "type": "string",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ShowPreviousContainer": {
          "type": "boolean"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        }
      },
      "additionalProperties": false
    },
    "BeginContainerLogsSessionResponse": {
      "type": "object",
      "required": [
        "SessionId"
      ],
      "properties": {
        "SessionId": {
          "type": "string",
          "format": "uuid"
        }
      },
      "additionalProperties": false
    },
    "BeginResourceEventsSessionCommand": {
      "type": "object",
      "required": [
        "DesiredOrKubernetesMonitoredResourceId",
        "EnvironmentId",
        "MachineId",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "DesiredOrKubernetesMonitoredResourceId": {
          "type": "string",
          "minLength": 1
        },
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "MachineId": {
          "type": "string",
          "example": "Machines-1"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        }
      },
      "additionalProperties": false
    },
    "BeginResourceEventsSessionResponse": {
      "type": "object",
      "required": [
        "SessionId"
      ],
      "properties": {
        "SessionId": {
          "type": "string",
          "format": "uuid"
        }
      },
      "additionalProperties": false
    },
    "BuiltInFeedStatsResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "TotalPackages": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "BulkDeleteBuildInformationCommand": {
      "type": "object",
      "required": [
        "Ids",
        "SpaceId"
      ],
      "properties": {
        "Ids": {
          "type": "array",
          "description": "IDs of the multiple Build Information to delete",
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "BulkDeletePackagesCommand": {
      "type": "object",
      "required": [
        "Ids",
        "SpaceId"
      ],
      "properties": {
        "Ids": {
          "type": "array",
          "description": "Ids of the Packages to delete",
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "BulkDeletePackagesResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "BulkUpdateActionTemplateActionsCommand": {
      "type": "object",
      "required": [
        "ActionsToUpdate",
        "Id",
        "SpaceId",
        "Version"
      ],
      "properties": {
        "ActionsToUpdate": {
          "type": "array",
          "description": "The actions to be updated to match the action template.",
          "items": {
            "$ref": "#/definitions/ActionsUpdateProcessResource"
          }
        },
        "DefaultPropertyValues": {
          "type": "object",
          "description": "Default values for properties of the action template.",
          "additionalProperties": {
            "$ref": "#/definitions/PropertyValueResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "The ID of the Action Template.",
          "example": "ActionTemplates-1"
        },
        "Overrides": {
          "type": "object",
          "description": "Overrides for values of the properties of the action template.",
          "additionalProperties": {
            "$ref": "#/definitions/PropertyValueResource"
          }
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the Space containing the Action Template.",
          "example": "Spaces-1"
        },
        "Version": {
          "type": "integer",
          "description": "The version of the Action Template.",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "BulkUpdateActionTemplateActionsResponse": {
      "type": "object",
      "required": [
        "Outcome",
        "Results"
      ],
      "properties": {
        "Outcome": {
          "type": "string",
          "minLength": 1
        },
        "Results": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionUpdateResultResource"
          }
        },
        "TaskId": {
          "type": "string",
          "example": "ServerTasks-1"
        },
        "ValidationFailures": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "CertificateConfigurationResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "SignatureAlgorithm": {
          "type": "string"
        },
        "Thumbprint": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CertificateConfigurationResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CertificateConfigurationResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "CertificateResource": {
      "type": "object",
      "properties": {
        "Archived": {
          "type": "string",
          "format": "date-time"
        },
        "CertificateChain": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/X509Certificate"
          }
        },
        "CertificateData": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "CertificateDataFormat": {
          "type": "string",
          "enum": [
            "Pkcs12",
            "Der",
            "Pem",
            "Unknown"
          ]
        },
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "HasPrivateKey": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsExpired": {
          "type": "boolean"
        },
        "IssuerCommonName": {
          "type": "string"
        },
        "IssuerDistinguishedName": {
          "type": "string"
        },
        "IssuerOrganization": {
          "type": "string"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "NotAfter": {
          "type": "string",
          "format": "date-time"
        },
        "NotBefore": {
          "type": "string",
          "format": "date-time"
        },
        "Notes": {
          "type": "string"
        },
        "Password": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "ReplacedBy": {
          "type": "string"
        },
        "SelfSigned": {
          "type": "boolean"
        },
        "SerialNumber": {
          "type": "string"
        },
        "SignatureAlgorithmName": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "SubjectAlternativeNames": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SubjectCommonName": {
          "type": "string",
          "description": "The certificate subject's common name (CN). When creating a self-signed certificate this becomes the generated certificate's CN, and at least one of SubjectCommonName or SubjectOrganization must be supplied."
        },
        "SubjectDistinguishedName": {
          "type": "string"
        },
        "SubjectOrganization": {
          "type": "string",
          "description": "The certificate subject's organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied."
        },
        "TenantedDeploymentParticipation": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "TenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Thumbprint": {
          "type": "string"
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "CertificateResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CertificateResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "CertificateResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CertificateResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "CertificateUsageResource": {
      "type": "object",
      "properties": {
        "DeploymentTargetUsages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/MachineResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LibraryVariableSetUsages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/LibraryVariableSetResource"
          }
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectUsages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ProjectResource"
          }
        },
        "TenantUsages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TenantResource"
          }
        }
      },
      "additionalProperties": false
    },
    "ChangeDetailsResource": {
      "type": "object",
      "properties": {
        "Differences": { },
        "DocumentContext": { }
      },
      "additionalProperties": false
    },
    "ChangeRequestSettings": {
      "type": "object",
      "properties": {
        "Type": {
          "type": "string",
          "enum": [
            "ServiceNow",
            "JiraServiceManagement"
          ],
          "readOnly": true
        }
      },
      "additionalProperties": false
    },
    "ChangeResource": {
      "type": "object",
      "required": [
        "ChangeRequestApprovalState",
        "Description",
        "Id"
      ],
      "properties": {
        "Active": {
          "type": "boolean"
        },
        "ChangeRequestApprovalState": {
          "type": "string",
          "minLength": 1
        },
        "Description": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string",
          "minLength": 1
        },
        "Number": {
          "type": "string"
        },
        "Self": {
          "type": "string",
          "format": "uri"
        },
        "Type": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ChannelCustomFieldDefinitionResource": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "FieldName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ChannelGitResourceRuleResource": {
      "type": "object",
      "properties": {
        "GitDependencyActions": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentActionGitDependencyResource"
          }
        },
        "Id": {
          "type": "string"
        },
        "Rules": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "ChannelResource": {
      "type": "object",
      "properties": {
        "AutomaticEphemeralEnvironmentDeployments": {
          "type": "boolean"
        },
        "CustomFieldDefinitions": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ChannelCustomFieldDefinitionResource"
          }
        },
        "Description": {
          "type": "string"
        },
        "EphemeralEnvironmentNameTemplate": {
          "type": "string"
        },
        "GitReferenceRules": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "GitResourceRules": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ChannelGitResourceRuleResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDefault": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LifecycleId": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "ParentEnvironmentId": {
          "type": "string",
          "description": "The parent environment for all ephemeral environments created in this channel.",
          "example": "Environments-1"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "Rules": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ChannelVersionRuleResource"
          }
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Type": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ChannelResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ChannelResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ChannelVersionRuleResource": {
      "type": "object",
      "properties": {
        "ActionPackages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentActionPackageResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Tag": {
          "type": "string"
        },
        "VersioningStrategy": {
          "type": "string"
        },
        "VersionRange": {
          "type": "string"
        },
        "VersionTagRegex": {
          "type": "string"
        }
      },
      "additionalProperties": { }
    },
    "CheckLoginInitiatedCommand": {
      "type": "object",
      "required": [
        "EncodedQueryString"
      ],
      "properties": {
        "EncodedQueryString": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ClaimDescriptor": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "IsIdentifyingClaim": {
          "type": "boolean"
        },
        "Label": {
          "type": "string"
        },
        "Type": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ClearGitCacheResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "CloudTemplateMetadata": {
      "type": "object",
      "properties": {
        "Metadata": {
          "$ref": "#/definitions/Metadata"
        },
        "Values": { }
      },
      "additionalProperties": false
    },
    "Commit": {
      "type": "object",
      "properties": {
        "Comment": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CommitDetails": {
      "type": "object",
      "properties": {
        "Comment": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "LinkUrl": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CommonTenantVariableUsage": {
      "type": "object",
      "properties": {
        "LibraryVariableSets": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CommonTenantVariableUsageEntry"
          }
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        }
      },
      "additionalProperties": false
    },
    "CommonTenantVariableUsageEntry": {
      "type": "object",
      "properties": {
        "LibraryVariableSetId": {
          "type": "string",
          "example": "LibraryVariableSets-1"
        },
        "TenantVariableId": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CommonVariableScope": {
      "type": "object",
      "required": [
        "EnvironmentIds"
      ],
      "properties": {
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        }
      },
      "additionalProperties": false
    },
    "CommunityActionTemplateResource": {
      "type": "object",
      "properties": {
        "Author": {
          "type": "string"
        },
        "Description": {
          "type": "string"
        },
        "HistoryUrl": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "Packages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PackageReferenceResource"
          }
        },
        "Parameters": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          },
          "readOnly": true
        },
        "Properties": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/PropertyValueResource"
          },
          "readOnly": true
        },
        "Type": {
          "type": "string"
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        },
        "Website": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CommunityActionTemplateResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CommunityActionTemplateResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "CommunityActionTemplateSnapshotResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string"
        },
        "Parameters": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          }
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "CompliancePolicyResource": {
      "type": "object",
      "required": [
        "ConditionsRego",
        "GitRef",
        "Name",
        "ScopeRego",
        "Slug",
        "ViolationAction"
      ],
      "properties": {
        "ConditionsRego": {
          "type": "string",
          "minLength": 1
        },
        "Description": {
          "type": "string"
        },
        "GitRef": {
          "type": "string",
          "minLength": 1
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ScopeRego": {
          "type": "string",
          "minLength": 1
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "ViolationAction": {
          "type": "string",
          "minLength": 1
        },
        "ViolationReason": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CompliancePolicyVersionResource": {
      "type": "object",
      "required": [
        "GitCommit",
        "GitRef",
        "Id",
        "IsActive",
        "Name",
        "PublishedDate",
        "RegoConditions",
        "RegoScope",
        "Slug",
        "Version",
        "ViolationAction"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "GitCommit": {
          "type": "string"
        },
        "GitRef": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string",
          "minLength": 1
        },
        "IsActive": {
          "type": "boolean"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "PublishedDate": {
          "type": "string",
          "format": "date-time"
        },
        "RegoConditions": {
          "type": "string",
          "minLength": 1
        },
        "RegoScope": {
          "type": "string",
          "minLength": 1
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "Version": {
          "type": "string",
          "minLength": 1
        },
        "ViolationAction": {
          "type": "string",
          "minLength": 1
        },
        "ViolationReason": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CompliancePolicyVersionResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CompliancePolicyVersionResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ConfigurationSection": {
      "type": "object",
      "required": [
        "Description",
        "Name"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ConfigurationSectionCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ConfigurationSection"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ConnectionAgentCredentialResource": {
      "type": "object",
      "required": [
        "Created",
        "Name",
        "Sha256"
      ],
      "properties": {
        "Created": {
          "type": "string",
          "description": "When this credential was created",
          "format": "date-time"
        },
        "Name": {
          "type": "string",
          "description": "The credential name"
        },
        "Sha256": {
          "type": "string",
          "description": "The SHA-256 hash of the credential",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ConnectionAgentForwardingRuleResource": {
      "type": "object",
      "required": [
        "ConnectionAgentName",
        "Fqdn",
        "IgnoreCertificateValidationErrors"
      ],
      "properties": {
        "ConnectionAgentName": {
          "type": "string",
          "description": "The name of the Connection Agent that matched requests will be forwarded to."
        },
        "Fqdn": {
          "type": "string",
          "description": "The fully qualified domain name to match against incoming requests.",
          "minLength": 1
        },
        "IgnoreCertificateValidationErrors": {
          "type": "boolean",
          "description": "Whether to ignore certificate validation errors from requests to the FQDN"
        },
        "LastModifiedOn": {
          "type": "string",
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "ConnectionAgentResource": {
      "type": "object",
      "required": [
        "ApiAudience",
        "Auth0ClientId",
        "AuthServerDomain",
        "ConnectionAgentName",
        "Credentials"
      ],
      "properties": {
        "ApiAudience": {
          "type": "string",
          "minLength": 1
        },
        "Auth0ClientId": {
          "type": "string",
          "minLength": 1
        },
        "AuthServerDomain": {
          "type": "string",
          "minLength": 1
        },
        "ConnectionAgentName": {
          "type": "string"
        },
        "Credentials": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ConnectionAgentCredentialResource"
          }
        },
        "LastModifiedOn": {
          "type": "string",
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "ConnectivityCheck": {
      "type": "object",
      "properties": {
        "DependsOnPropertyNames": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Title": {
          "type": "string"
        },
        "Url": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ConnectivityCheckMessage": {
      "type": "object",
      "required": [
        "Category",
        "Message"
      ],
      "properties": {
        "Category": {
          "type": "string",
          "enum": [
            "Info",
            "Warning",
            "Error"
          ]
        },
        "Message": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ContainerLogLineResource": {
      "type": "object",
      "properties": {
        "Message": {
          "type": "string"
        },
        "Timestamp": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "Control": {
      "type": "object",
      "properties": {
        "Type": {
          "type": "string",
          "enum": [
            "Checkbox",
            "TextArea",
            "Paragraph",
            "SubmitButtonGroup",
            "VariableValue"
          ],
          "readOnly": true
        }
      },
      "additionalProperties": false
    },
    "ConvertProjectRunbooksToGitCommand": {
      "type": "object",
      "required": [
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "Branch": {
          "type": "string",
          "description": "Branch to commit the migrated Runbooks to. Required if there are Runbooks to migrate."
        },
        "CommitMessage": {
          "type": "string",
          "description": "Commit message to use when committing the migrated Runbooks to Git. Required if there are Runbooks to migrate"
        },
        "CreateBranch": {
          "type": "boolean"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ConvertProjectRunbooksToGitResponse": {
      "type": "object",
      "required": [
        "DraftRunbooks",
        "PublishedRunbooks"
      ],
      "properties": {
        "DraftRunbooks": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookSummary"
          }
        },
        "PublishedRunbooks": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookSummary"
          }
        },
        "ServerTaskId": {
          "type": "string",
          "example": "ServerTasks-1"
        }
      },
      "additionalProperties": false
    },
    "ConvertProjectToVersionControlledCommand": {
      "type": "object",
      "required": [
        "ChangeDescription",
        "ProjectId",
        "SpaceId",
        "VersionControlSettings"
      ],
      "properties": {
        "ChangeDescription": {
          "type": "string",
          "minLength": 1
        },
        "CommitMessage": {
          "type": "string"
        },
        "InitialCommitBranchName": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        },
        "VersionControlSettings": {
          "$ref": "#/definitions/GitPersistenceSettingsResource"
        }
      },
      "additionalProperties": false
    },
    "ConvertProjectToVersionControlledResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ConvertProjectVariablesToGitCommand": {
      "type": "object",
      "required": [
        "Branch",
        "CommitMessage",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "Branch": {
          "type": "string"
        },
        "CommitMessage": {
          "type": "string",
          "minLength": 1
        },
        "CreateBranch": {
          "type": "boolean"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ConvertProjectVariablesToGitResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ConvertProjectVariablesToGitSummaryResponse": {
      "type": "object",
      "required": [
        "SensitiveVariableCount",
        "TextVariableCount"
      ],
      "properties": {
        "SensitiveVariableCount": {
          "type": "integer",
          "format": "int32"
        },
        "TextVariableCount": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ConvertRunbookToGitSummaryResponse": {
      "type": "object",
      "required": [
        "DraftRunbooks",
        "PublishedRunbooks"
      ],
      "properties": {
        "DraftRunbooks": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookSummary"
          }
        },
        "PublishedRunbooks": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookSummary"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateAccountCommand": {
      "type": "object",
      "required": [
        "Details",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/AccountDetailsResource"
        },
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantedDeploymentParticipation": {
          "type": "string"
        },
        "TenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateActionTemplateCommand": {
      "type": "object",
      "required": [
        "ActionType",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "ActionType": {
          "type": "string",
          "description": "The action type of the Action Template.",
          "minLength": 1
        },
        "CommunityActionTemplateId": {
          "type": "string",
          "description": "The community action template id if the Action Template is created from a community template.",
          "example": "CommunityActionTemplates-1"
        },
        "Description": {
          "type": "string",
          "description": "The description of the Action Template."
        },
        "GitDependencies": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitDependencyResource"
          }
        },
        "Inputs": {
          "$ref": "#/definitions/StepPackageInputsResource"
        },
        "Name": {
          "type": "string",
          "description": "The name of the Action Template.",
          "minLength": 1
        },
        "Packages": {
          "type": "array",
          "description": "The list of packages to include in the Action Template.",
          "items": {
            "$ref": "#/definitions/PackageReferenceResource"
          }
        },
        "Parameters": {
          "type": "array",
          "description": "The list of parameters of the Action Template.",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          }
        },
        "Properties": {
          "type": "object",
          "description": "The list of properties of the Action Template.",
          "additionalProperties": {
            "$ref": "#/definitions/PropertyValueResource"
          }
        },
        "SpaceId": {
          "type": "string",
          "description": "The id of the Space that contains the Action Template.",
          "example": "Spaces-1"
        },
        "StepPackageVersion": {
          "type": "string",
          "description": "The step package version if the Action Template is created from a step package."
        },
        "Version": {
          "type": "integer",
          "description": "The version number of the Action Template.",
          "format": "int32",
          "maximum": 2147483647,
          "minimum": 0
        }
      },
      "additionalProperties": false
    },
    "CreateApprovalCommand": {
      "type": "object",
      "required": [
        "Notes",
        "ServerTaskApprovalId",
        "SpaceId",
        "Status"
      ],
      "properties": {
        "Notes": {
          "type": "string",
          "description": "A reason for approving or rejecting the deployment",
          "minLength": 1
        },
        "ServerTaskApprovalId": {
          "type": "string",
          "description": "The Server Task Approval id"
        },
        "SpaceId": {
          "type": "string",
          "description": "The id of the space for the Approval.",
          "example": "Spaces-1"
        },
        "Status": {
          "type": "string",
          "description": "Approve or reject the deployment. [\"Approved\", \"Rejected\"]"
        }
      },
      "additionalProperties": false
    },
    "CreateApprovalRuleCommand": {
      "type": "object",
      "required": [
        "Name",
        "SpaceId"
      ],
      "properties": {
        "AllowSelfApproval": {
          "type": "boolean",
          "description": "Whether deployment creators are allowed to approve their own deployments"
        },
        "ApprovingTeamIds": {
          "type": "array",
          "description": "The teams who are authorized to approve",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Teams-1",
            "..."
          ]
        },
        "ApprovingUserIds": {
          "type": "array",
          "description": "The users who are authorized to approve",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Users-1",
            "..."
          ]
        },
        "Description": {
          "type": "string"
        },
        "IdScopes": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ApprovalRuleIdScopeResource"
          }
        },
        "IsDisabled": {
          "type": "boolean",
          "description": "Whether this approval rule is disabled"
        },
        "MinimumApproversRequired": {
          "type": "integer",
          "description": "Set a number of minimum approvers required to authorize the deployment",
          "format": "int32",
          "maximum": 100,
          "minimum": 1
        },
        "Name": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "ScopingStrategy": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TagScopes": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ApprovalRuleTagScopeResource"
          }
        },
        "TenantApprovalStrategy": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CreateArtifactCommand": {
      "type": "object",
      "description": "Creates a new artifact.",
      "required": [
        "Filename",
        "ServerTaskId",
        "SpaceId"
      ],
      "properties": {
        "Filename": {
          "type": "string",
          "description": "The filename of the Artifact to create",
          "minLength": 1,
          "example": "Performance Test Results.csv"
        },
        "LogCorrelationId": {
          "type": "string",
          "description": "Gets the correlationId of the log block in which the artifact was captured",
          "example": "0c5a872485ac4b10857939a92d082e67"
        },
        "ServerTaskId": {
          "type": "string",
          "description": "The server task with which this artifact is associated.",
          "example": "ServerTasks-1"
        },
        "Source": {
          "type": "string",
          "description": "A short summary of the source of this attachment. This will typically be the name of a step/machine, or \"Uploaded by [username]\" if the attachment was uploaded by a person."
        },
        "SpaceId": {
          "type": "string",
          "description": "ID of the space",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateBranchCommandV2": {
      "type": "object",
      "required": [
        "BaseGitRef",
        "NewBranchName",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "BaseGitRef": {
          "type": "string"
        },
        "NewBranchName": {
          "type": "string",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateBuildInformationCommand": {
      "type": "object",
      "required": [
        "OctopusBuildInformation",
        "PackageId",
        "SpaceId",
        "Version"
      ],
      "properties": {
        "OctopusBuildInformation": {
          "$ref": "#/definitions/OctopusBuildInformation"
        },
        "OverwriteMode": {
          "type": "string",
          "enum": [
            "FailIfExists",
            "OverwriteExisting",
            "IgnoreIfExists"
          ]
        },
        "PackageId": {
          "type": "string",
          "minLength": 1
        },
        "Replace": {
          "type": "boolean"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Version": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "CreateCertificateCommand": {
      "type": "object",
      "description": "Adds a new certificate",
      "required": [
        "CertificateData",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "CertificateData": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Notes": {
          "type": "string",
          "maxLength": 10240
        },
        "Password": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantedDeploymentParticipation": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "TenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateChannelCommand": {
      "type": "object",
      "required": [
        "Name",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "AutomaticEphemeralEnvironmentDeployments": {
          "type": "boolean"
        },
        "CustomFieldDefinitions": {
          "type": "array",
          "description": "Custom fields (FieldName plus a human-facing Description) that become mandatory when creating a release in this channel.",
          "items": {
            "$ref": "#/definitions/ChannelCustomFieldDefinitionResource"
          }
        },
        "Description": {
          "type": "string"
        },
        "EphemeralEnvironmentNameTemplate": {
          "type": "string",
          "maxLength": 1000
        },
        "GitReferenceRules": {
          "type": "array",
          "description": "Git reference patterns (e.g. 'refs/heads/main', 'refs/heads/feature/*') restricting which branches or tags can create releases in this channel. Only valid for version-controlled (Config-as-Code) projects.",
          "items": {
            "type": "string"
          }
        },
        "GitResourceRules": {
          "type": "array",
          "description": "Rules restricting which Git refs may be used for external Git dependencies referenced by deployment steps. Each rule targets step Git dependencies via GitDependencyActions (DeploymentActionSlug plus GitDependencyName) and lists the allowed Git reference patterns in Rules.",
          "items": {
            "$ref": "#/definitions/ChannelGitResourceRuleResource"
          }
        },
        "IsDefault": {
          "type": "boolean"
        },
        "LifecycleId": {
          "type": "string",
          "description": "The lifecycle for this channel. Must be null for ephemeral environment channels."
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ParentEnvironmentId": {
          "type": "string",
          "description": "The parent environment for all ephemeral environments created in this channel. Required for ephemeral environment channels.",
          "example": "Environments-1"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "Rules": {
          "type": "array",
          "description": "Version rules restricting which package versions may be used when creating a release in this channel. Each rule targets step packages via ActionPackages (DeploymentAction is the step name or ID, PackageReference the package reference name or ID) and constrains versions with a NuGet-style VersionRange (e.g. '[1.0,2.0)') and/or a Tag regex matched against the package's pre-release tag (e.g. '^$' for stable versions only). Leave each rule's Id blank; the server assigns it.",
          "items": {
            "$ref": "#/definitions/ChannelVersionRuleResource"
          }
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantTags": {
          "type": "array",
          "description": "Canonical tenant tag names in 'TagSet/Tag' format restricting which tenants can deploy releases from this channel.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Type": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CreateCompliancePolicyCommand": {
      "type": "object",
      "required": [
        "ConditionsRego",
        "GitRef",
        "Name",
        "ScopeRego",
        "Slug",
        "ViolationAction"
      ],
      "properties": {
        "ChangeDescription": {
          "type": "string"
        },
        "ConditionsRego": {
          "type": "string",
          "minLength": 1
        },
        "Description": {
          "type": "string"
        },
        "GitRef": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ScopeRego": {
          "type": "string",
          "minLength": 1
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "ViolationAction": {
          "type": "string",
          "minLength": 1
        },
        "ViolationReason": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CreateConnectionAgentRegistrationCommand": {
      "type": "object",
      "required": [
        "ConnectionAgentName",
        "CredentialName",
        "CredentialValue"
      ],
      "properties": {
        "ConnectionAgentName": {
          "type": "string",
          "description": "The Connection Agent Name"
        },
        "CredentialName": {
          "type": "string",
          "description": "The friendly name of the credential to add"
        },
        "CredentialValue": {
          "type": "string",
          "description": "The public key to add",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "CreateDeploymentCommand": {
      "type": "object",
      "required": [
        "EnvironmentId",
        "ReleaseId"
      ],
      "properties": {
        "ChangeRequestSettings": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ChangeRequestSettings"
          }
        },
        "Changes": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseChangesResource"
          }
        },
        "ChangesMarkdown": {
          "type": "string"
        },
        "ChannelId": {
          "type": "string",
          "example": "Channels-1"
        },
        "Comments": {
          "type": "string"
        },
        "Created": {
          "type": "string",
          "format": "date-time"
        },
        "DebugMode": {
          "type": "string"
        },
        "DeployedBy": {
          "type": "string"
        },
        "DeployedById": {
          "type": "string"
        },
        "DeployedToMachineIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "DeploymentProcessId": {
          "type": "string"
        },
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "ExcludedMachineIds": {
          "type": "array",
          "description": "A collection of machines in the target environment that should be excluded from the deployment.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ExcludedTargetTagIds": {
          "type": "array",
          "description": "A collection of target tag IDs that should be excluded from the deployment. Only deployment targets that have none of these tags will be deployed to. Tag IDs are in the format \"TagSets-{id}/Tags-{id}\".",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ExecutionPlanLogContext": {
          "$ref": "#/definitions/ExecutionPlanLogContext"
        },
        "FailTargetDiscovery": {
          "type": "boolean"
        },
        "FailureEncountered": {
          "type": "boolean"
        },
        "ForcePackageDownload": {
          "type": "boolean"
        },
        "ForcePackageRedeployment": {
          "type": "boolean"
        },
        "FormValues": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource.",
          "example": "Deployments-1"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ManifestVariableSetId": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "Priority": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "QueueTime": {
          "type": "string",
          "description": "If set this time will be the used to schedule the deployment to a later time, null is assumed to mean the time will be executed immediately.",
          "format": "date-time"
        },
        "QueueTimeExpiry": {
          "type": "string",
          "format": "date-time"
        },
        "ReleaseId": {
          "type": "string",
          "example": "Releases-1"
        },
        "SkipActions": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "SpecificMachineIds": {
          "type": "array",
          "description": "A collection of machines in the target environment that should be deployed to. If the collection is empty, all enabled machines are deployed.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpecificTargetTagIds": {
          "type": "array",
          "description": "A collection of target tag IDs that should be included in the deployment. Only deployment targets that have at least one of these tags will be deployed to. Tag IDs are in the format \"TagSets-{id}/Tags-{id}\".",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "TaskId": {
          "type": "string",
          "example": "ServerTasks-1"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        },
        "TentacleRetentionPeriod": {
          "$ref": "#/definitions/RetentionPeriod"
        },
        "UseGuidedFailure": {
          "type": "boolean",
          "description": "If set to true, the deployment will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable."
        }
      },
      "additionalProperties": false
    },
    "CreateDeploymentFreezeCommand": {
      "type": "object",
      "required": [
        "End",
        "Name",
        "Start"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "End": {
          "type": "string",
          "format": "date-time"
        },
        "Name": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "ProjectEnvironmentScope": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          }
        },
        "Start": {
          "type": "string",
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "CreateDeploymentFreezeOverrideCommand": {
      "type": "object",
      "required": [
        "CreateDeploymentCommand",
        "FreezeIds",
        "Reason",
        "SpaceId"
      ],
      "properties": {
        "CreateDeploymentCommand": {
          "$ref": "#/definitions/CreateDeploymentCommand"
        },
        "FreezeIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Reason": {
          "type": "string",
          "minLength": 1
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateDeploymentFreezeOverrideResponse": {
      "type": "object",
      "required": [
        "Deployment"
      ],
      "properties": {
        "Deployment": {
          "$ref": "#/definitions/DeploymentResource"
        }
      },
      "additionalProperties": false
    },
    "CreateDeploymentFreezeResponse": {
      "type": "object",
      "required": [
        "End",
        "Id",
        "Name",
        "Start"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "End": {
          "type": "string",
          "format": "date-time"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectEnvironmentScope": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          }
        },
        "RecurringSchedule": {
          "$ref": "#/definitions/RecurringScheduleResource"
        },
        "Start": {
          "type": "string",
          "format": "date-time"
        },
        "TenantProjectEnvironmentScope": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "$ref": "#/definitions/TenantProjectEnvironment"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateDeploymentResponse": {
      "type": "object",
      "required": [
        "Deployment"
      ],
      "properties": {
        "Deployment": {
          "$ref": "#/definitions/DeploymentResource"
        }
      },
      "additionalProperties": false
    },
    "CreateDeploymentTargetCommand": {
      "type": "object",
      "description": "Creates a new deployment target.",
      "required": [
        "EnvironmentIds",
        "Name",
        "Roles",
        "SpaceId"
      ],
      "properties": {
        "Endpoint": {
          "$ref": "#/definitions/EndpointResource"
        },
        "EnvironmentIds": {
          "type": "array",
          "minItems": 1,
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "MachinePolicyId": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Roles": {
          "type": "array",
          "minItems": 1,
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SkipInitialHealthCheck": {
          "type": "boolean"
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantedDeploymentParticipation": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "TenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Thumbprint": {
          "type": "string"
        },
        "Uri": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CreateDeploymentTargetTagCommand": {
      "type": "object",
      "required": [
        "SpaceId",
        "Tag"
      ],
      "properties": {
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space for the DeploymentTargetTag",
          "example": "Spaces-1"
        },
        "Tag": {
          "type": "string",
          "description": "The name or tag of the DeploymentTargetTag",
          "maxLength": 200,
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "CreateDeploymentTargetTagResponse": {
      "type": "object",
      "required": [
        "SpaceId",
        "Tag"
      ],
      "properties": {
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Tag": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CreateDeploymentTenantedCommandV1": {
      "type": "object",
      "required": [
        "EnvironmentName",
        "ProjectName",
        "ReleaseVersion",
        "SpaceId",
        "SpaceIdOrName"
      ],
      "properties": {
        "DebugMode": {
          "type": "string",
          "description": "Contributes the OctopusPrintVariables and OctopusPrintEvaluatedVariables variables to the execution. One of \"None\", \"Log\" or \"Debug\"; leave unset for the default of \"None\"."
        },
        "DeploymentFreezeNames": {
          "type": "array",
          "description": "Active deployment freezes to override so this execution can proceed despite them. Overriding a freeze bypasses a deliberate block on deploying, so only set this when explicitly asked to. Requires DeploymentFreezeOverrideReason.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "DeploymentFreezeOverrideReason": {
          "type": "string",
          "description": "Required, and must not be blank, whenever DeploymentFreezeNames is non-empty. Recorded against the override."
        },
        "EnvironmentName": {
          "type": "string",
          "description": "A single environment. To deploy to several, call the command once per environment."
        },
        "ExcludedMachineNames": {
          "type": "array",
          "description": "A collection of machines in the target environment that should be excluded from the deployment.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ExcludedTargetTagNames": {
          "type": "array",
          "description": "A collection of deployment target tags (canonical names in format TagSetName/TagName) that should be excluded from the deployment.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ForcePackageDownload": {
          "type": "boolean",
          "description": "Whether to force downloading of already installed packages (flag, default false)."
        },
        "ForcePackageRedeployment": {
          "type": "boolean",
          "description": "If a project is configured to skip packages with already-installed versions, override this setting to force re-deployment (flag, default false)."
        },
        "NoRunAfter": {
          "type": "string",
          "description": "Time at which a scheduled execution should expire if it has not started, specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone. Only meaningful alongside RunAt.",
          "format": "date-time"
        },
        "Priority": {
          "type": "string",
          "description": "Whether this execution jumps the task queue ahead of other queued tasks. One of \"LifecycleDefault\" (use the lifecycle's configured setting), \"On\" or \"Off\"."
        },
        "ProjectName": {
          "type": "string"
        },
        "ReleaseVersion": {
          "type": "string",
          "description": "The version of an existing release, for example \"1.2.3\" — not a release ID.",
          "minLength": 1
        },
        "RunAt": {
          "type": "string",
          "description": "Time at which the execution should start (scheduling it for later), specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone.",
          "format": "date-time"
        },
        "SkipStepNames": {
          "type": "array",
          "description": "Steps that are to be skipped for this execution. A name that matches no step is logged as a warning rather than failing the command, so check the step name carefully.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "SpaceIdOrName": {
          "type": "string",
          "description": "Both this and SpaceId are required, and normally hold the same space ID; set both."
        },
        "SpecificMachineNames": {
          "type": "array",
          "description": "A collection of machines in the target environment that should be deployed to. If the collection is empty, all enabled machines are deployed. A name that matches no machine fails the command.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpecificTargetTagNames": {
          "type": "array",
          "description": "A collection of deployment target tags (canonical names in format TagSetName/TagName) that should be included in the deployment.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Tenants": {
          "type": "array",
          "description": "The tenants to deploy for; one deployment is created per tenant. Set this or TenantTags — with both empty nothing is deployed and no error is raised. The single entry \"*\" means every tenant that can be deployed to this environment, which may be a very large number — only use it when explicitly asked to deploy to all tenants.",
          "items": {
            "type": "string"
          }
        },
        "TenantTags": {
          "type": "array",
          "description": "Tenant tags, in canonical \"TagSetName/TagName\" form, selecting the tenants to deploy for. Set this or Tenants — with both empty nothing is deployed and no error is raised.",
          "items": {
            "type": "string"
          }
        },
        "UpdateVariableSnapshot": {
          "type": "boolean",
          "description": "If set to true, the release's variable set snapshot is updated from the project's current variables before the deployment. This mutates the release itself, so it affects later deployments of it too — leave it unset unless refreshed variables were asked for."
        },
        "UseGuidedFailure": {
          "type": "boolean",
          "description": "If set to true, the deployment will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable."
        },
        "Variables": {
          "type": "object",
          "description": "Name/value pairs for prompted variables. A prompted variable that is required and has no value supplied here fails the command, naming the variable.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateDeploymentTenantedResponseV1": {
      "type": "object",
      "required": [
        "DeploymentServerTasks"
      ],
      "properties": {
        "DeploymentServerTasks": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentServerTask"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateDeploymentUntenantedCommandV1": {
      "type": "object",
      "required": [
        "EnvironmentNames",
        "ProjectName",
        "ReleaseVersion",
        "SpaceId",
        "SpaceIdOrName"
      ],
      "properties": {
        "DebugMode": {
          "type": "string",
          "description": "Contributes the OctopusPrintVariables and OctopusPrintEvaluatedVariables variables to the execution. One of \"None\", \"Log\" or \"Debug\"; leave unset for the default of \"None\"."
        },
        "DeploymentFreezeNames": {
          "type": "array",
          "description": "Active deployment freezes to override so this execution can proceed despite them. Overriding a freeze bypasses a deliberate block on deploying, so only set this when explicitly asked to. Requires DeploymentFreezeOverrideReason.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "DeploymentFreezeOverrideReason": {
          "type": "string",
          "description": "Required, and must not be blank, whenever DeploymentFreezeNames is non-empty. Recorded against the override."
        },
        "EnvironmentNames": {
          "type": "array",
          "description": "One deployment is created per environment. Always name at least one: an empty list is not rejected, it simply deploys nothing and returns an empty list of deployments.",
          "items": {
            "type": "string"
          }
        },
        "ExcludedMachineNames": {
          "type": "array",
          "description": "A collection of machines in the target environment that should be excluded from the deployment.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ExcludedTargetTagNames": {
          "type": "array",
          "description": "A collection of deployment target tags (canonical names in format TagSetName/TagName) that should be excluded from the deployment.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ForcePackageDownload": {
          "type": "boolean",
          "description": "Whether to force downloading of already installed packages (flag, default false)."
        },
        "ForcePackageRedeployment": {
          "type": "boolean",
          "description": "If a project is configured to skip packages with already-installed versions, override this setting to force re-deployment (flag, default false)."
        },
        "NoRunAfter": {
          "type": "string",
          "description": "Time at which a scheduled execution should expire if it has not started, specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone. Only meaningful alongside RunAt.",
          "format": "date-time"
        },
        "Priority": {
          "type": "string",
          "description": "Whether this execution jumps the task queue ahead of other queued tasks. One of \"LifecycleDefault\" (use the lifecycle's configured setting), \"On\" or \"Off\"."
        },
        "ProjectName": {
          "type": "string"
        },
        "ReleaseVersion": {
          "type": "string",
          "description": "The version of an existing release, for example \"1.2.3\" — not a release ID.",
          "minLength": 1
        },
        "RunAt": {
          "type": "string",
          "description": "Time at which the execution should start (scheduling it for later), specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone.",
          "format": "date-time"
        },
        "SkipStepNames": {
          "type": "array",
          "description": "Steps that are to be skipped for this execution. A name that matches no step is logged as a warning rather than failing the command, so check the step name carefully.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "SpaceIdOrName": {
          "type": "string",
          "description": "Both this and SpaceId are required, and normally hold the same space ID; set both."
        },
        "SpecificMachineNames": {
          "type": "array",
          "description": "A collection of machines in the target environment that should be deployed to. If the collection is empty, all enabled machines are deployed. A name that matches no machine fails the command.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpecificTargetTagNames": {
          "type": "array",
          "description": "A collection of deployment target tags (canonical names in format TagSetName/TagName) that should be included in the deployment.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "UpdateVariableSnapshot": {
          "type": "boolean",
          "description": "If set to true, the release's variable set snapshot is updated from the project's current variables before the deployment. This mutates the release itself, so it affects later deployments of it too — leave it unset unless refreshed variables were asked for."
        },
        "UseGuidedFailure": {
          "type": "boolean",
          "description": "If set to true, the deployment will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable."
        },
        "Variables": {
          "type": "object",
          "description": "Name/value pairs for prompted variables. A prompted variable that is required and has no value supplied here fails the command, naming the variable.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateDeploymentUntenantedResponseV1": {
      "type": "object",
      "required": [
        "DeploymentServerTasks"
      ],
      "properties": {
        "DeploymentServerTasks": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentServerTask"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateEnvironmentCommand": {
      "type": "object",
      "required": [
        "Name",
        "SpaceId"
      ],
      "properties": {
        "AllowDynamicInfrastructure": {
          "type": "boolean"
        },
        "Description": {
          "type": "string"
        },
        "EnvironmentTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ExtensionSettings": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ExtensionSettingsValues"
          }
        },
        "Name": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        },
        "SortOrder": {
          "type": "integer",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "UseGuidedFailure": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "CreateEphemeralEnvironmentCommand": {
      "type": "object",
      "required": [
        "EnvironmentName",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "EnvironmentName": {
          "type": "string",
          "description": "The name to give the new ephemeral environment.",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateEphemeralEnvironmentResponse": {
      "type": "object",
      "required": [
        "Id"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "example": "Environments-1"
        }
      },
      "additionalProperties": false
    },
    "CreateFeatureToggleCommand": {
      "type": "object",
      "required": [
        "Environments",
        "Name",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "maxLength": 1000
        },
        "Environments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CreateFeatureToggleEnvironment"
          }
        },
        "Name": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "RolloutGroupId": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateFeatureToggleEnvironment": {
      "type": "object",
      "required": [
        "DeploymentEnvironmentId",
        "IsEnabled"
      ],
      "properties": {
        "ClientRolloutPercentage": {
          "type": "integer",
          "format": "int32",
          "maximum": 100,
          "minimum": 0
        },
        "DeploymentEnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "ExcludedTenantIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "ExcludedTenantTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "IsEnabled": {
          "type": "boolean"
        },
        "MinimumVersion": {
          "type": "string",
          "description": "A semantic version, for example '2.1.0'. When set, the toggle is only enabled for clients whose application version, reported through the feature toggle SDK, is at or above this version."
        },
        "RolloutPercentage": {
          "type": "integer",
          "format": "int32",
          "maximum": 100,
          "minimum": 0
        },
        "Segments": {
          "type": "array",
          "description": "Key/value targeting rules matched against the evaluation context supplied by the client application through the feature toggle SDK, for example {\"key\": \"region\", \"value\": \"us-east\"}. When set, the toggle is only enabled for clients whose context matches.",
          "maxItems": 100,
          "items": {
            "$ref": "#/definitions/StringStringKeyValuePair"
          }
        },
        "TenantIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateFeedCommand": {
      "type": "object",
      "required": [
        "FeedType",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "ClientVersion": {
          "$ref": "#/definitions/SemanticVersion"
        },
        "FeedType": {
          "type": "string",
          "description": "The type of the feed.",
          "enum": [
            "None",
            "NuGet",
            "Docker",
            "Maven",
            "OctopusProject",
            "GitHub",
            "Helm",
            "OciRegistry",
            "AwsElasticContainerRegistry",
            "BuiltIn",
            "S3",
            "AzureContainerRegistry",
            "GoogleContainerRegistry",
            "ArtifactoryGeneric",
            "Npm",
            "GcsStorage",
            "PyPi"
          ]
        },
        "Name": {
          "type": "string",
          "description": "The name of the feed.",
          "maxLength": 44,
          "minLength": 0
        },
        "PackageAcquisitionLocationOptions": {
          "type": "array",
          "description": "The feed's package acquisition location options.",
          "items": {
            "type": "string",
            "enum": [
              "Server",
              "ExecutionTarget",
              "NotAcquired"
            ]
          }
        },
        "Slug": {
          "type": "string",
          "description": "The slug of the feed."
        },
        "SpaceId": {
          "type": "string",
          "description": "The id of the space that contains the feed.",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateGitCredentialCommand": {
      "type": "object",
      "required": [
        "Details",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/NewGitCredentialDetails"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "RepositoryRestrictions": {
          "$ref": "#/definitions/GitCredentialRepositoryRestrictionsResource"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateGitCredentialCommandV2": {
      "type": "object",
      "required": [
        "Details",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/NewGitCredentialDetailsV2"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "RepositoryRestrictions": {
          "$ref": "#/definitions/GitCredentialRepositoryRestrictionsResource"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateGitCredentialResponse": {
      "type": "object",
      "required": [
        "Id",
        "Links"
      ],
      "properties": {
        "Id": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateGitCredentialResponseV2": {
      "type": "object",
      "required": [
        "Id"
      ],
      "properties": {
        "Id": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CreateGitHubAppConnectionCommand": {
      "type": "object",
      "required": [
        "InstallationId",
        "RepositoryIds",
        "SpaceId"
      ],
      "properties": {
        "InstallationId": {
          "type": "string",
          "minLength": 1
        },
        "RepositoryIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateInsightsReportCommand": {
      "type": "object",
      "description": "Creates a new Insights Report.",
      "required": [
        "ChannelIds",
        "EnvironmentGroups",
        "Name",
        "ProjectGroupIds",
        "ProjectIds",
        "SpaceId",
        "TenantIds",
        "TenantTags",
        "TimeZone"
      ],
      "properties": {
        "AllTenants": {
          "type": "boolean",
          "description": "If true, all tenants in the space will be included in the report."
        },
        "ChannelIds": {
          "type": "array",
          "description": "The channels for the report.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Channels-1",
            "..."
          ]
        },
        "Description": {
          "type": "string",
          "description": "The description for the report."
        },
        "EnvironmentGroups": {
          "type": "array",
          "description": "The environment groups for the report.",
          "items": {
            "$ref": "#/definitions/InsightsEnvironmentGroupResource"
          }
        },
        "Name": {
          "type": "string",
          "description": "The name of the report.",
          "maxLength": 200,
          "minLength": 1
        },
        "ProjectGroupIds": {
          "type": "array",
          "description": "The project groups for the report.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "ProjectGroups-1",
            "..."
          ]
        },
        "ProjectIds": {
          "type": "array",
          "description": "The projects for the report.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Projects-1",
            "..."
          ]
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantIds": {
          "type": "array",
          "description": "The tenants for the report.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantMode": {
          "type": "string",
          "description": "The kind of deployments that will be included in this report",
          "enum": [
            "Untenanted",
            "TenantedAndUntenanted",
            "Tenanted"
          ]
        },
        "TenantTags": {
          "type": "array",
          "description": "The tenant tags the report.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "TimeZone": {
          "type": "string",
          "description": "The timezone of the report."
        }
      },
      "additionalProperties": false
    },
    "CreateInsightsReportResponse": {
      "type": "object",
      "required": [
        "Report"
      ],
      "properties": {
        "Report": {
          "$ref": "#/definitions/InsightsReportResource"
        }
      },
      "additionalProperties": false
    },
    "CreateInvitationCommand": {
      "type": "object",
      "required": [
        "AddToTeamIds"
      ],
      "properties": {
        "AddToTeamIds": {
          "type": "array",
          "description": "The teams the user will be invited to join",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Teams-1",
            "..."
          ]
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space to create the invitation in.",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateLibraryVariableSetsCommand": {
      "type": "object",
      "required": [
        "Name",
        "SpaceId"
      ],
      "properties": {
        "ContentType": {
          "type": "string",
          "description": "Describes the purpose of the variable set. Clients can use this to offer an editing experience appropriately.",
          "enum": [
            "Variables",
            "ScriptModule"
          ]
        },
        "Description": {
          "type": "string",
          "description": "A description of this variable set that explains the purpose of the variable set to other users. This field may contain markdown."
        },
        "Name": {
          "type": "string",
          "description": "The name of this variable set. This should be short, preferably 5-20 characters.",
          "minLength": 1
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Templates": {
          "type": "array",
          "description": "Variable templates for tenant-specific values: each template defines a variable (name, label, help text, control type and default value) that every tenant connected to a linked project must supply a value for. Leave empty unless working with tenants.",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateLifecycleCommand": {
      "type": "object",
      "required": [
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "description": "A description of the Lifecycle"
        },
        "Name": {
          "type": "string",
          "description": "The name of the Lifecycle.",
          "minLength": 1
        },
        "Phases": {
          "type": "array",
          "description": "The promotion phases in order. Each phase lists environments deployed to automatically (AutomaticDeploymentTargets) or manually (OptionalDeploymentTargets); an environment may appear in only one phase, and at most one phase may list no environments, meaning all remaining environments. MinimumEnvironmentsBeforePromotion is how many of the phase's environments must be deployed before a release can progress (0 means all). IsOptionalPhase allows skipping the phase, but not every phase may be optional. Per-phase retention policies override the lifecycle-level ones. Leave each phase's Id blank; the server assigns it.",
          "items": {
            "$ref": "#/definitions/PhaseResource"
          }
        },
        "ReleaseRetentionPolicy": {
          "$ref": "#/definitions/RetentionPeriod"
        },
        "Slug": {
          "type": "string",
          "description": "A slug for the Lifecycle."
        },
        "SpaceId": {
          "type": "string",
          "description": "The id of the Space for the Lifecycle.",
          "example": "Spaces-1"
        },
        "TentacleRetentionPolicy": {
          "$ref": "#/definitions/RetentionPeriod"
        }
      },
      "additionalProperties": false
    },
    "CreateMachinePolicyCommand": {
      "type": "object",
      "required": [
        "Name",
        "SpaceId"
      ],
      "properties": {
        "ConnectionConnectTimeout": {
          "type": "string",
          "format": "date-span"
        },
        "ConnectionRetryCountLimit": {
          "type": "integer",
          "format": "int32"
        },
        "ConnectionRetrySleepInterval": {
          "type": "string",
          "format": "date-span"
        },
        "ConnectionRetryTimeLimit": {
          "type": "string",
          "format": "date-span"
        },
        "Description": {
          "type": "string"
        },
        "IsDefault": {
          "type": "boolean"
        },
        "MachineCleanupPolicy": {
          "$ref": "#/definitions/MachineCleanupPolicyResource"
        },
        "MachineConnectivityPolicy": {
          "$ref": "#/definitions/MachineConnectivityPolicyResource"
        },
        "MachineHealthCheckPolicy": {
          "$ref": "#/definitions/MachineHealthCheckPolicyResource"
        },
        "MachinePackageCacheRetentionPolicy": {
          "$ref": "#/definitions/MachinePackageCacheRetentionPolicyResource"
        },
        "MachineRpcCallRetryPolicy": {
          "$ref": "#/definitions/MachineRpcCallRetryPolicyResource"
        },
        "MachineUpdatePolicy": {
          "$ref": "#/definitions/MachineUpdatePolicyResource"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "PollingRequestQueueTimeout": {
          "type": "string",
          "format": "date-span"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateMigrationImportTaskCommand": {
      "type": "object",
      "description": "The import API lets you import a migration package from your Octopus Server's built-in package feed (which is where packages are pushed to when using the partial-export API).",
      "required": [
        "PackageId",
        "PackageVersion",
        "Password"
      ],
      "properties": {
        "DeletePackageOnCompletion": {
          "type": "boolean",
          "description": "Removes the migration package that you're importing from on successful completion of the import"
        },
        "FailureCallbackUri": {
          "type": "string",
          "description": "A webhook URL you can add if you wish to be notified on failure of the migration task *(Your Octopus Server will call this URL using a GET request)*"
        },
        "IsDryRun": {
          "type": "boolean",
          "description": "Do not commit changes, just print what would have happened *(This allows you to test an import without actually committing the transaction)*",
          "example": true
        },
        "IsEncryptedPackage": {
          "type": "boolean",
          "description": "Tells us whether the package was encrypted *(E.g. if you set `EncryptPackage` on export, you need to set this to `True`)*",
          "example": true
        },
        "OverwriteExisting": {
          "type": "boolean",
          "description": "If a document with the same name already exists, it will be skipped by default"
        },
        "PackageFeedSpaceId": {
          "type": "string",
          "description": "If using the Spaces feature, the ID of the Space where the package containing the data to migrate will be uploaded. This is only for the package; the data in the package specifies its own destination Space.",
          "example": "Spaces-1"
        },
        "PackageId": {
          "type": "string",
          "description": "Package Name/ID that we are importing",
          "example": "MyAwesomeOctopusMigration"
        },
        "PackageVersion": {
          "type": "string",
          "description": "SemVer package version that we are importing",
          "minLength": 1,
          "example": "1.0.0"
        },
        "Password": {
          "type": "string",
          "description": "Password that was used during the export migration *(This is the shared key between partial-export and import migrations)*",
          "minLength": 1,
          "example": "Demo1234"
        },
        "SuccessCallbackUri": {
          "type": "string",
          "description": "A webhook URL you can add if you wish to be notified on successful completion of the migration task *(Your Octopus Server will call this URL using a GET request, appending the `packageId` and `packageVersion` to the URL)*"
        }
      },
      "additionalProperties": false
    },
    "CreateMigrationPartialExportTaskCommand": {
      "type": "object",
      "description": "Using the partial-export API, we can export one or more of our projects and choose to send the package to the destination Octopus Server's package feed.",
      "required": [
        "Password",
        "Projects"
      ],
      "properties": {
        "DestinationApiKey": {
          "type": "string",
          "description": "The API key of your destination server *(Where you'll be importing this exported package)*",
          "example": "API-YOUR-DESTINATION-KEY"
        },
        "DestinationPackageFeed": {
          "type": "string",
          "description": "The destination Octopus Server base URL",
          "example": "https://YOUR_DESTINATION_OCTOPUS_SERVER"
        },
        "DestinationPackageFeedSpaceId": {
          "type": "string",
          "description": "The ID of the Space the Destination Package Feed is located in",
          "example": "Spaces-1"
        },
        "EncryptPackage": {
          "type": "boolean",
          "description": "Encrypt the contents of your migration package *(Uses the `Password` as a shared key so this can be decrypted by your destination server). Defaults to false if not provided*",
          "example": true
        },
        "FailureCallbackUri": {
          "type": "string",
          "description": "A webhook URL you can add if you wish to be notified on failure of the migration task *(Your Octopus Server will call this URL using a GET request)*"
        },
        "IgnoreCertificates": {
          "type": "boolean",
          "description": "Excludes certificates from partial export"
        },
        "IgnoreDeployments": {
          "type": "boolean",
          "description": "Excludes deployments from partial export"
        },
        "IgnoreMachines": {
          "type": "boolean",
          "description": "Excludes machines from partial export"
        },
        "IgnoreTenants": {
          "type": "boolean",
          "description": "Excludes tenants from partial export"
        },
        "IncludeTaskLogs": {
          "type": "boolean",
          "description": "Include the task log folder as part of the export",
          "example": true
        },
        "PackageId": {
          "type": "string",
          "description": "Package Name/ID for your export *(Defaults to `Octopus.Space.Migration` if not provided)*",
          "example": "MyAwesomeOctopusMigration"
        },
        "PackageVersion": {
          "type": "string",
          "description": "SemVer package version for your export *(Defaults to `1.0.0-{RandomStringGenerator.Generate(8)}` if not provided)*",
          "example": "1.0.0"
        },
        "Password": {
          "type": "string",
          "description": "Password to encrypt both the migration package and any sensitive values (This is the shared key between partial-export and import migrations)",
          "minLength": 1,
          "example": "Demo1234"
        },
        "Projects": {
          "type": "array",
          "description": "Projects to include in the migration",
          "items": {
            "type": "string"
          },
          "example": [
            "Projects-1",
            "..."
          ]
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "SuccessCallbackUri": {
          "type": "string",
          "description": "A webhook URL you can add if you wish to be notified on successful completion of the migration task *(Your Octopus Server will call this URL using a GET request, appending the `packageId` and `packageVersion` to the URL as querystring parameters)*"
        }
      },
      "additionalProperties": false
    },
    "CreateOrCloneRunbookInDatabaseCommand": {
      "type": "object",
      "required": [
        "Name",
        "ProjectId",
        "RunRetentionPolicy",
        "SpaceId"
      ],
      "properties": {
        "Clone": {
          "type": "string",
          "description": "The ID of an existing database runbook to copy. Cloning brings across the source runbook's settings, its process and steps, and any project triggers that target it. The source runbook's tags come across too, unless you supply RunbookTags. Leave unset to create a runbook from scratch, which starts with an empty process.",
          "example": "Runbooks-1"
        },
        "ConnectivityPolicy": {
          "$ref": "#/definitions/DeploymentConnectivityPolicy"
        },
        "DefaultGuidedFailureMode": {
          "type": "string",
          "description": "What a run does when a step fails. One of 'EnvironmentDefault' (follow the target environment's setting), 'Off' (fail the run immediately, the default), or 'On' (pause the run and wait for someone to choose whether to retry, ignore or abort).",
          "enum": [
            "EnvironmentDefault",
            "Off",
            "On"
          ]
        },
        "Description": {
          "type": "string",
          "description": "The description of the Runbook to create."
        },
        "Environments": {
          "type": "array",
          "description": "The environments the runbook may be run in. Only applies when EnvironmentScope is 'Specified'; ignored otherwise.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "EnvironmentScope": {
          "type": "string",
          "description": "Which environments the runbook may be run in. One of 'All' (every environment in the space, the default), 'Specified' (only the environments listed in Environments), or 'FromProjectLifecycles' (only the environments used by the project's lifecycles).",
          "enum": [
            "All",
            "Specified",
            "FromProjectLifecycles"
          ]
        },
        "ForcePackageDownload": {
          "type": "boolean",
          "description": "Re-download every package on each run instead of reusing the copy already cached on the deployment target."
        },
        "MultiTenancyMode": {
          "type": "string",
          "description": "Whether the runbook can be run for tenants. One of 'Untenanted' (untenanted runs only, the default), 'Tenanted' (a tenant must be supplied for every run), or 'TenantedOrUntenanted' (either is allowed).",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "Name": {
          "type": "string",
          "description": "The name of the Runbook to create.",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "description": "The ID of the project to create the runbook in. Must be a project that stores its runbooks in the Octopus database.",
          "example": "Projects-1"
        },
        "PublishedRunbookSnapshotId": {
          "type": "string",
          "description": "Leave unset. A snapshot can only be published after the runbook exists and has a process."
        },
        "RunbookProcessId": {
          "type": "string",
          "description": "Leave unset. Octopus creates an empty runbook process for the new runbook and links it automatically.",
          "example": "RunbookProcess-Runbooks-1"
        },
        "RunbookTags": {
          "type": "array",
          "description": "Tags to apply to the runbook, each written as \"TagSet/Tag\" using either the names or the IDs of the tag set and tag (for example \"Ops/Nightly\"). Call find_tag_sets to discover which tag sets apply to runbooks and what tags they contain.",
          "items": {
            "type": "string"
          }
        },
        "RunRetentionPolicy": {
          "$ref": "#/definitions/RunbookRetentionPolicy"
        },
        "Slug": {
          "type": "string",
          "description": "A short URL-friendly identifier for the runbook, unique within the project. Generated from the name when omitted."
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateParentEnvironmentCommand": {
      "type": "object",
      "required": [
        "Name",
        "SpaceId"
      ],
      "properties": {
        "AutomaticDeprovisioningRule": {
          "$ref": "#/definitions/AutomaticDeprovisioningRuleResource"
        },
        "Description": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "UseGuidedFailure": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "CreateParentEnvironmentResponse": {
      "type": "object",
      "required": [
        "Id"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "example": "Environments-1"
        }
      },
      "additionalProperties": false
    },
    "CreatePlatformHubAccountCommand": {
      "type": "object",
      "required": [
        "Details",
        "Name"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/AccountDetailsResource"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CreatePlatformHubAccountResponse": {
      "type": "object",
      "required": [
        "Id"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "example": "Accounts-1"
        }
      },
      "additionalProperties": false
    },
    "CreatePlatformHubBranchCommand": {
      "type": "object",
      "required": [
        "BaseGitRef",
        "NewBranchName"
      ],
      "properties": {
        "BaseGitRef": {
          "type": "string"
        },
        "NewBranchName": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "CreatePlatformHubCertificateCommand": {
      "type": "object",
      "required": [
        "CertificateData",
        "Name"
      ],
      "properties": {
        "CertificateData": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Notes": {
          "type": "string",
          "maxLength": 10240
        },
        "Password": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "Slug": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CreatePlatformHubFeedCommand": {
      "type": "object",
      "required": [
        "FeedType",
        "Name"
      ],
      "properties": {
        "FeedType": {
          "type": "string",
          "description": "The type of the feed.",
          "enum": [
            "None",
            "NuGet",
            "Docker",
            "Maven",
            "OctopusProject",
            "GitHub",
            "Helm",
            "OciRegistry",
            "AwsElasticContainerRegistry",
            "BuiltIn",
            "S3",
            "AzureContainerRegistry",
            "GoogleContainerRegistry",
            "ArtifactoryGeneric",
            "Npm",
            "GcsStorage",
            "PyPi"
          ]
        },
        "Name": {
          "type": "string",
          "description": "The name of the feed.",
          "maxLength": 44,
          "minLength": 0
        },
        "PackageAcquisitionLocationOptions": {
          "type": "array",
          "description": "The feed's package acquisition location options.",
          "items": {
            "type": "string",
            "enum": [
              "Server",
              "ExecutionTarget",
              "NotAcquired"
            ]
          }
        },
        "Slug": {
          "type": "string",
          "description": "The slug of the feed."
        }
      },
      "additionalProperties": false
    },
    "CreatePlatformHubGitCredentialCommand": {
      "type": "object",
      "required": [
        "Details",
        "Name"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/NewPlatformHubGitCredentialDetails"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "RepositoryRestrictions": {
          "$ref": "#/definitions/GitCredentialRepositoryRestrictionsResource"
        }
      },
      "additionalProperties": false
    },
    "CreatePlatformHubGitCredentialCommandV2": {
      "type": "object",
      "required": [
        "Details",
        "Name"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/NewPlatformHubGitCredentialDetailsV2"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "RepositoryRestrictions": {
          "$ref": "#/definitions/GitCredentialRepositoryRestrictionsResource"
        }
      },
      "additionalProperties": false
    },
    "CreatePlatformHubGitCredentialResponse": {
      "type": "object",
      "required": [
        "Id"
      ],
      "properties": {
        "Id": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CreatePlatformHubGitCredentialResponseV2": {
      "type": "object",
      "required": [
        "Id"
      ],
      "properties": {
        "Id": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CreatePlatformHubGitHubAppConnectionCommand": {
      "type": "object",
      "required": [
        "InstallationId",
        "RepositoryIds"
      ],
      "properties": {
        "InstallationId": {
          "type": "string",
          "minLength": 1
        },
        "RepositoryIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateProcessTemplateCommand": {
      "type": "object",
      "required": [
        "GitRef",
        "Name"
      ],
      "properties": {
        "ChangeDescription": {
          "type": "string"
        },
        "Description": {
          "type": "string"
        },
        "GitRef": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "CreateProcessTemplateVersionCommand": {
      "type": "object",
      "required": [
        "GitRef",
        "IsPreRelease",
        "Slug",
        "Version"
      ],
      "properties": {
        "GitRef": {
          "type": "string"
        },
        "IsPreRelease": {
          "type": "boolean"
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "Version": {
          "type": "string",
          "description": "The version of the process template. Must follow the semantic versioning format.",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "CreateProjectCommand": {
      "type": "object",
      "required": [
        "LifecycleId",
        "Name",
        "ProjectGroupId",
        "SpaceId"
      ],
      "properties": {
        "AllowIgnoreChannelRules": {
          "type": "boolean"
        },
        "AutoCreateRelease": {
          "type": "boolean"
        },
        "AutoDeployReleaseOverrides": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/AutoDeployReleaseOverrideResource"
          }
        },
        "Clone": {
          "type": "string",
          "description": "ID of an existing project in the same space whose configuration (deployment process, variables, channels, runbooks, triggers) is copied into the new project. The source project must store its configuration in the database, not Git.",
          "example": "Projects-1"
        },
        "CombineHealthAndSyncStatusInDashboardLiveStatus": {
          "type": "boolean"
        },
        "DefaultGuidedFailureMode": {
          "type": "string",
          "enum": [
            "EnvironmentDefault",
            "Off",
            "On"
          ]
        },
        "DefaultToSkipIfAlreadyInstalled": {
          "type": "boolean"
        },
        "DeploymentChangesTemplate": {
          "type": "string"
        },
        "Description": {
          "type": "string"
        },
        "DiscreteChannelRelease": {
          "type": "boolean",
          "description": "Treats releases of different channels to the same environment as a seperate deployment dimension. 'False' indicates a \"hotfix\"-style usage of channels (single release active per environment ignoring channels), whereas `True` indicates \"microservice\"-style usage (single release per environment per channel)"
        },
        "ExecuteDeploymentsOnEventBasedPipeline": {
          "type": "boolean"
        },
        "ExtensionSettings": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ExtensionSettingsValues"
          }
        },
        "ForcePackageDownload": {
          "type": "boolean"
        },
        "IncludedLibraryVariableSetIds": {
          "type": "array",
          "description": "Library variable sets included in the project. Sets are listed in order of precedence, with earlier items in the list overriding any variables with the same name and scope definition appearing later in the list.",
          "items": {
            "type": "string"
          }
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "LifecycleId": {
          "type": "string",
          "example": "Lifecycles-1"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "PersistenceSettings": {
          "$ref": "#/definitions/PersistenceSettingsResource"
        },
        "ProjectConnectivityPolicy": {
          "$ref": "#/definitions/DeploymentConnectivityPolicy"
        },
        "ProjectGroupId": {
          "type": "string",
          "example": "ProjectGroups-1"
        },
        "ProjectTags": {
          "type": "array",
          "description": "Tags to apply to the project, each written as \"TagSet/Tag\" using either the names or the IDs of the tag set and tag (for example \"Regions/us-east\"). Call find_tag_sets to discover which tag sets apply to projects and what tags they contain.",
          "items": {
            "type": "string"
          }
        },
        "ReleaseCreationStrategy": {
          "$ref": "#/definitions/ReleaseCreationStrategyResource"
        },
        "ReleaseNotesTemplate": {
          "type": "string"
        },
        "RetainTenantConnections": {
          "type": "boolean",
          "description": "When cloning, copy the source project's tenant connections to the new project. Only honoured when Clone is set. Defaults to false."
        },
        "Slug": {
          "type": "string",
          "description": "URL-friendly short identifier for the project, unique within the space (for example \"web-store\"). Leave unset to have one generated from the name."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Templates": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          }
        },
        "TenantedDeploymentMode": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "VersioningStrategy": {
          "$ref": "#/definitions/VersioningStrategyResource"
        }
      },
      "additionalProperties": false
    },
    "CreateProjectGroupCommand": {
      "type": "object",
      "required": [
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "description": "The description of the project group"
        },
        "Name": {
          "type": "string",
          "description": "The name of the project group.",
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateProjectTriggerCommand": {
      "type": "object",
      "required": [
        "Action",
        "Filter",
        "Name",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "Action": {
          "$ref": "#/definitions/TriggerActionResource"
        },
        "Description": {
          "type": "string",
          "description": "Description for the project trigger"
        },
        "Filter": {
          "$ref": "#/definitions/TriggerFilterResource"
        },
        "IsDisabled": {
          "type": "boolean",
          "description": "Disables the trigger from being run when set"
        },
        "Name": {
          "type": "string",
          "description": "Name of the project trigger",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "description": "Id of the project to create a trigger in",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "Id of the space where the project is located",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateProxyCommand": {
      "type": "object",
      "required": [
        "Host",
        "Name",
        "Port",
        "SpaceId"
      ],
      "properties": {
        "Host": {
          "type": "string",
          "minLength": 1
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Password": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "Port": {
          "type": "integer",
          "format": "int32",
          "maximum": 65535,
          "minimum": 0
        },
        "ProxyType": {
          "type": "string",
          "description": "The type of proxy. Currently only HTTP is supported."
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource.",
          "example": "Spaces-1"
        },
        "Username": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CreateReleaseCommand": {
      "type": "object",
      "required": [
        "ProjectId",
        "SpaceId",
        "Version"
      ],
      "properties": {
        "Assembled": {
          "type": "string",
          "format": "date-time"
        },
        "ChannelId": {
          "type": "string",
          "example": "Channels-1"
        },
        "CustomFields": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "IgnoreChannelRules": {
          "type": "boolean",
          "description": "Ignore channel rules."
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ReleaseNotes": {
          "type": "string"
        },
        "SelectedGitResources": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SelectedGitResource"
          }
        },
        "SelectedPackages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SelectedPackage"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Version": {
          "type": "string",
          "maxLength": 349,
          "minLength": 0
        },
        "VersionControlReference": {
          "$ref": "#/definitions/SnapshotGitReferenceResource"
        }
      },
      "additionalProperties": false
    },
    "CreateReleaseCommandV1": {
      "type": "object",
      "required": [
        "ProjectName",
        "SpaceId",
        "SpaceIdOrName"
      ],
      "properties": {
        "ChannelName": {
          "type": "string",
          "description": "Name of the channel to use for the new release. Omit this argument to automatically select the best channel."
        },
        "CustomFields": {
          "type": "object",
          "description": "Values for the project's custom release fields, if it defines any, keyed by field name.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "GitCommit": {
          "type": "string",
          "description": "Only set alongside GitRef, when a specific commit is needed; GitRef alone uses the tip of that ref."
        },
        "GitRef": {
          "type": "string",
          "description": "The Git branch, tag or commit to snapshot the deployment process from. Required for a project that stores its configuration in Git, and must be left unset for one stored in the database — the command fails either way round. List a project's branches with get_branches."
        },
        "GitResources": {
          "type": "array",
          "description": "Git ref to use for a git resource in the release. Format: StepName:GitRef or StepName:GitResourceName:GitRef. If the GitResourceName is omitted, it's assumed to be the primary git resource for the step. The GitRef can be replaced with an asterisk. An asterisk will use the tip ref of the step-defined default branch.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "IgnoreChannelRules": {
          "type": "boolean",
          "description": "Create the release even when a package version, or the Git reference, violates the channel's version rules. This overrides a deliberate guardrail, so prefer correcting the versions or letting Octopus select the channel; only set it when explicitly asked to."
        },
        "IgnoreIfAlreadyExists": {
          "type": "boolean",
          "description": "If a release with the same version number already exists, return that one instead of failing — so the returned ReleaseId may be an existing release rather than a newly created one."
        },
        "PackagePrerelease": {
          "type": "string",
          "description": "Restrict automatic version selection to pre-release versions carrying this tag, for example \"beta\". Ignored for steps whose version is pinned by PackageVersion or Packages."
        },
        "Packages": {
          "type": "array",
          "description": "Version number to use for a package in the release. Format: StepName:Version or PackageID:Version or StepName:PackageName:Version. StepName, PackageID, and PackageName can be replaced with an asterisk. An asterisk will be assumed for StepName, PackageID, or PackageName if they are omitted.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "PackageVersion": {
          "type": "string",
          "description": "One version to use for every package step. Leave unset to take the latest version of each package; use Packages instead to pin versions per step."
        },
        "ProjectName": {
          "type": "string"
        },
        "ReleaseNotes": {
          "type": "string",
          "description": "Release Notes for the new release. Styling with Markdown is supported."
        },
        "ReleaseVersion": {
          "type": "string",
          "description": "Leave unset to let Octopus pick the next version from the project's versioning strategy, which is usually what you want."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "SpaceIdOrName": {
          "type": "string",
          "description": "Both this and SpaceId are required, and normally hold the same space ID; set both."
        }
      },
      "additionalProperties": false
    },
    "CreateReleaseDefectCommand": {
      "type": "object",
      "required": [
        "Description",
        "ReleaseId",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "description": "Defect in the release",
          "minLength": 1
        },
        "ReleaseId": {
          "type": "string",
          "description": "Id of the release",
          "example": "Releases-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s)",
          "example": "Spaces-1"
        },
        "Status": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CreateReleaseResponseV1": {
      "type": "object",
      "required": [
        "ReleaseId",
        "ReleaseVersion"
      ],
      "properties": {
        "ReleaseId": {
          "type": "string",
          "example": "Releases-1"
        },
        "ReleaseVersion": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "CreateRolloutGroupCommand": {
      "type": "object",
      "required": [
        "Name",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "Name": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateRunbookInDatabaseCommandV2": {
      "type": "object",
      "required": [
        "Name",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "ConnectivityPolicy": {
          "$ref": "#/definitions/DeploymentConnectivityPolicy"
        },
        "DefaultGuidedFailureMode": {
          "type": "string",
          "enum": [
            "EnvironmentDefault",
            "Off",
            "On"
          ]
        },
        "Description": {
          "type": "string"
        },
        "Environments": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "EnvironmentScope": {
          "type": "string",
          "enum": [
            "All",
            "Specified",
            "FromProjectLifecycles"
          ]
        },
        "ForcePackageDownload": {
          "type": "boolean"
        },
        "MultiTenancyMode": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "RunbookTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "RunRetentionPolicy": {
          "$ref": "#/definitions/RunbookRetentionPolicy"
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateRunbookInDatabaseResponseV2": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "ProjectId",
        "Slug"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "example": "Runbooks-1"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "CreateRunbookInGitCommandV2": {
      "type": "object",
      "required": [
        "GitRef",
        "Name",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "ChangeDescription": {
          "type": "string"
        },
        "ConnectivityPolicy": {
          "$ref": "#/definitions/DeploymentConnectivityPolicy"
        },
        "DefaultGuidedFailureMode": {
          "type": "string",
          "enum": [
            "EnvironmentDefault",
            "Off",
            "On"
          ]
        },
        "Description": {
          "type": "string"
        },
        "Environments": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "EnvironmentScope": {
          "type": "string",
          "enum": [
            "All",
            "Specified",
            "FromProjectLifecycles"
          ]
        },
        "ForcePackageDownload": {
          "type": "boolean"
        },
        "GitRef": {
          "type": "string"
        },
        "MultiTenancyMode": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "RunbookTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "RunRetentionPolicy": {
          "$ref": "#/definitions/RunbookRetentionPolicy"
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateRunbookInGitResponseV2": {
      "type": "object",
      "required": [
        "GitRef",
        "Id",
        "Name",
        "ProjectId",
        "Slug"
      ],
      "properties": {
        "GitRef": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string",
          "example": "Runbooks-1"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "CreateRunbookRunCommand": {
      "type": "object",
      "required": [
        "EnvironmentId",
        "RunbookId",
        "RunbookSnapshotId",
        "SpaceId"
      ],
      "properties": {
        "ChangeRequestSettings": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ChangeRequestSettings"
          }
        },
        "Comments": {
          "type": "string"
        },
        "DebugMode": {
          "type": "string"
        },
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "ExcludedMachineIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ExcludedTargetTagIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "FailTargetDiscovery": {
          "type": "boolean"
        },
        "ForcePackageDownload": {
          "type": "boolean"
        },
        "FormValues": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Priority": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "QueueTime": {
          "type": "string",
          "format": "date-time"
        },
        "QueueTimeExpiry": {
          "type": "string",
          "format": "date-time"
        },
        "RunbookId": {
          "type": "string",
          "example": "Runbooks-1"
        },
        "RunbookSnapshotId": {
          "type": "string"
        },
        "SkipActions": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "SpecificMachineIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpecificTargetTagIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        },
        "UseGuidedFailure": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "CreateRunbookRunCommandV1": {
      "type": "object",
      "required": [
        "EnvironmentNames",
        "ProjectName",
        "RunbookName",
        "SpaceId",
        "SpaceIdOrName"
      ],
      "properties": {
        "DebugMode": {
          "type": "string",
          "description": "Contributes the OctopusPrintVariables and OctopusPrintEvaluatedVariables variables to the execution. One of \"None\", \"Log\" or \"Debug\"; leave unset for the default of \"None\"."
        },
        "DeploymentFreezeNames": {
          "type": "array",
          "description": "Active deployment freezes to override so this execution can proceed despite them. Overriding a freeze bypasses a deliberate block on deploying, so only set this when explicitly asked to. Requires DeploymentFreezeOverrideReason.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "DeploymentFreezeOverrideReason": {
          "type": "string",
          "description": "Required, and must not be blank, whenever DeploymentFreezeNames is non-empty. Recorded against the override."
        },
        "EnvironmentNames": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ExcludedMachineNames": {
          "type": "array",
          "description": "A collection of machines in the target environment that should be excluded from the deployment.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ExcludedTargetTagNames": {
          "type": "array",
          "description": "A collection of deployment target tags (canonical names in format TagSetName/TagName) that should be excluded from the deployment.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ForcePackageDownload": {
          "type": "boolean",
          "description": "Whether to force downloading of already installed packages (flag, default false)."
        },
        "NoRunAfter": {
          "type": "string",
          "description": "Time at which a scheduled execution should expire if it has not started, specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone. Only meaningful alongside RunAt.",
          "format": "date-time"
        },
        "Priority": {
          "type": "string",
          "description": "Whether this execution jumps the task queue ahead of other queued tasks. One of \"LifecycleDefault\" (use the lifecycle's configured setting), \"On\" or \"Off\"."
        },
        "ProjectName": {
          "type": "string"
        },
        "RunAt": {
          "type": "string",
          "description": "Time at which the execution should start (scheduling it for later), specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone.",
          "format": "date-time"
        },
        "RunbookName": {
          "type": "string"
        },
        "SkipStepNames": {
          "type": "array",
          "description": "Steps that are to be skipped for this execution. A name that matches no step is logged as a warning rather than failing the command, so check the step name carefully.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Snapshot": {
          "type": "string",
          "description": "Name or ID of the snapshot to run. If not supplied, the command will attempt to use the published snapshot."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "SpaceIdOrName": {
          "type": "string",
          "description": "Both this and SpaceId are required, and normally hold the same space ID; set both."
        },
        "SpecificMachineNames": {
          "type": "array",
          "description": "A collection of machines in the target environment that should be deployed to. If the collection is empty, all enabled machines are deployed. A name that matches no machine fails the command.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpecificTargetTagNames": {
          "type": "array",
          "description": "A collection of deployment target tags (canonical names in format TagSetName/TagName) that should be included in the deployment.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Tenants": {
          "type": "array",
          "description": "The tenants to deploy.",
          "items": {
            "type": "string"
          }
        },
        "TenantTags": {
          "type": "array",
          "description": "The tenant tags to filter tenants to deploy.",
          "items": {
            "type": "string"
          }
        },
        "UseGuidedFailure": {
          "type": "boolean",
          "description": "If set to true, the deployment will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable."
        },
        "Variables": {
          "type": "object",
          "description": "Name/value pairs for prompted variables. A prompted variable that is required and has no value supplied here fails the command, naming the variable.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateRunbookRunResponseV1": {
      "type": "object",
      "required": [
        "RunbookRunServerTasks"
      ],
      "properties": {
        "RunbookRunServerTasks": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunRunbookServerTask"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateRunbookSnapshotCommand": {
      "type": "object",
      "required": [
        "Name",
        "ProjectId",
        "RunbookId",
        "SpaceId"
      ],
      "properties": {
        "Name": {
          "type": "string",
          "description": "The name of the runbook snapshot.",
          "minLength": 1
        },
        "Notes": {
          "type": "string",
          "description": "Any additional information about the runbook snapshot."
        },
        "ProjectId": {
          "type": "string",
          "description": "ID of the project that owns the runbook to snapshot.",
          "example": "Projects-1"
        },
        "Publish": {
          "type": "string",
          "description": "Publishes the snapshot when set to any non-blank value, making it the snapshot that runbook triggers and 'published' runs use. The value itself is not stored. Leave unset to create the snapshot without publishing it."
        },
        "RunbookId": {
          "type": "string",
          "description": "ID of the runbook to snapshot.",
          "example": "Runbooks-1"
        },
        "SelectedGitResources": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SelectedGitResource"
          }
        },
        "SelectedPackages": {
          "type": "array",
          "description": "The packages and versions used in the runbook snapshot.",
          "items": {
            "$ref": "#/definitions/SelectedPackage"
          }
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateScopedUserRoleCommand": {
      "type": "object",
      "required": [
        "TeamId",
        "UserRoleId"
      ],
      "properties": {
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "ProjectGroupIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "ProjectGroups-1",
            "..."
          ]
        },
        "ProjectIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Projects-1",
            "..."
          ]
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TeamId": {
          "type": "string",
          "minLength": 1
        },
        "TenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "UserRoleId": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "CreateSelfSignedCertificateCommand": {
      "type": "object",
      "properties": {
        "Archived": {
          "type": "string",
          "format": "date-time"
        },
        "CertificateChain": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/X509Certificate"
          }
        },
        "CertificateData": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "CertificateDataFormat": {
          "type": "string",
          "enum": [
            "Pkcs12",
            "Der",
            "Pem",
            "Unknown"
          ]
        },
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "HasPrivateKey": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsExpired": {
          "type": "boolean"
        },
        "IssuerCommonName": {
          "type": "string"
        },
        "IssuerDistinguishedName": {
          "type": "string"
        },
        "IssuerOrganization": {
          "type": "string"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "NotAfter": {
          "type": "string",
          "format": "date-time"
        },
        "NotBefore": {
          "type": "string",
          "format": "date-time"
        },
        "Notes": {
          "type": "string"
        },
        "Password": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "ReplacedBy": {
          "type": "string"
        },
        "SelfSigned": {
          "type": "boolean"
        },
        "SelfSignedCertificateCurve": {
          "type": "string",
          "description": "Elliptic curve for the generated key pair: nistP256, nistP384 or nistP521. Defaults to nistP384 when omitted."
        },
        "SerialNumber": {
          "type": "string"
        },
        "SignatureAlgorithmName": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "SubjectAlternativeNames": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SubjectCommonName": {
          "type": "string",
          "description": "The certificate subject's common name (CN). When creating a self-signed certificate this becomes the generated certificate's CN, and at least one of SubjectCommonName or SubjectOrganization must be supplied."
        },
        "SubjectDistinguishedName": {
          "type": "string"
        },
        "SubjectOrganization": {
          "type": "string",
          "description": "The certificate subject's organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied."
        },
        "TenantedDeploymentParticipation": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "TenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Thumbprint": {
          "type": "string"
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "CreateSelfSignedPlatformHubCertificateCommand": {
      "type": "object",
      "properties": {
        "Archived": {
          "type": "string",
          "format": "date-time"
        },
        "CertificateChain": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/X509Certificate"
          }
        },
        "CertificateData": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "CertificateDataFormat": {
          "type": "string",
          "enum": [
            "Pkcs12",
            "Der",
            "Pem",
            "Unknown"
          ]
        },
        "HasPrivateKey": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsExpired": {
          "type": "boolean"
        },
        "IssuerCommonName": {
          "type": "string"
        },
        "IssuerDistinguishedName": {
          "type": "string"
        },
        "IssuerOrganization": {
          "type": "string"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "NotAfter": {
          "type": "string",
          "format": "date-time"
        },
        "NotBefore": {
          "type": "string",
          "format": "date-time"
        },
        "Notes": {
          "type": "string"
        },
        "Password": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "ReplacedBy": {
          "type": "string"
        },
        "SelfSigned": {
          "type": "boolean"
        },
        "SelfSignedCertificateCurve": {
          "type": "string"
        },
        "SerialNumber": {
          "type": "string"
        },
        "SignatureAlgorithmName": {
          "type": "string"
        },
        "Slug": {
          "type": "string",
          "description": "The slug of the certificate."
        },
        "SubjectAlternativeNames": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SubjectCommonName": {
          "type": "string",
          "description": "The certificate subject's common name (CN). When creating a self-signed certificate this becomes the generated certificate's CN, and at least one of SubjectCommonName or SubjectOrganization must be supplied."
        },
        "SubjectDistinguishedName": {
          "type": "string"
        },
        "SubjectOrganization": {
          "type": "string",
          "description": "The certificate subject's organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied."
        },
        "Thumbprint": {
          "type": "string"
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "CreateServerTaskCommand": {
      "type": "object",
      "required": [
        "Description",
        "Name"
      ],
      "properties": {
        "Arguments": {
          "type": "object",
          "additionalProperties": { }
        },
        "Description": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "QueueTime": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "QueueTimeExpiry": {
          "type": "string",
          "format": "date-time"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Weight": {
          "type": "number"
        }
      },
      "additionalProperties": false
    },
    "CreateServiceAccountOidcIdentityCommandV1": {
      "type": "object",
      "required": [
        "Issuer",
        "Name",
        "ServiceAccountId",
        "Subject"
      ],
      "properties": {
        "Audience": {
          "type": "string",
          "description": "The audience of tokens for the identity"
        },
        "Issuer": {
          "type": "string",
          "description": "Gets the issuer of tokens for the identity",
          "minLength": 1
        },
        "Name": {
          "type": "string",
          "description": "The name of the ServiceAccountOidcIdentity.",
          "maxLength": 200,
          "minLength": 1
        },
        "ServiceAccountId": {
          "type": "string",
          "description": "The id of the service account that the identity belonds to",
          "example": "Users-1"
        },
        "Subject": {
          "type": "string",
          "description": "Gets the subject of tokens for the identity",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "CreateServiceAccountOidcIdentityResponseV1": {
      "type": "object",
      "required": [
        "Id"
      ],
      "properties": {
        "Id": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "CreateSpaceCommandV1": {
      "type": "object",
      "required": [
        "Name",
        "SpaceManagersTeamMembers",
        "SpaceManagersTeams"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "IsDefault": {
          "type": "boolean"
        },
        "Name": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1
        },
        "Slug": {
          "type": "string",
          "maxLength": 50
        },
        "SpaceManagersTeamMembers": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Users-1",
            "..."
          ]
        },
        "SpaceManagersTeams": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "TaskQueueStopped": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "CreateSpaceResponseV1": {
      "type": "object",
      "required": [
        "Space"
      ],
      "properties": {
        "Space": {
          "$ref": "#/definitions/SpaceResource"
        }
      },
      "additionalProperties": false
    },
    "CreateSubscriptionCommand": {
      "type": "object",
      "required": [
        "EventNotificationSubscription",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "EventNotificationSubscription": {
          "$ref": "#/definitions/EventNotificationSubscriptionResource"
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource.",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateTagSetCommand": {
      "type": "object",
      "required": [
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "description": "Sets the description of this tag set."
        },
        "Name": {
          "type": "string",
          "description": "Sets the name of this tag set.",
          "minLength": 1
        },
        "Scopes": {
          "type": "array",
          "description": "The resource types the tag set applies to. Valid values: 'Tenant', 'Environment', 'Project', 'Target', 'Runbook', 'Feature Toggle'. Defaults to ['Tenant'] when omitted.",
          "items": {
            "type": "string"
          }
        },
        "SortOrder": {
          "type": "integer",
          "description": "Sets the sort order of this tag set.",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Tags": {
          "type": "array",
          "description": "The tags that make up the tag set. Each tag is an object with a 'Name', an optional 'Description', a 'Color' hex code (e.g. '#3156B3'), and a 'SortOrder'. Leave empty for a 'FreeText' tag set, which does not allow predefined tags.",
          "items": {
            "$ref": "#/definitions/TagResource"
          }
        },
        "Type": {
          "type": "string",
          "description": "How tags from the set are applied to a resource: 'MultiSelect' (any number of tags), 'SingleSelect' (one tag at a time), or 'FreeText' (arbitrary values, no predefined tags). Defaults to 'MultiSelect' when omitted."
        }
      },
      "additionalProperties": false
    },
    "CreateTeamCommand": {
      "type": "object",
      "required": [
        "ExternalSecurityGroups",
        "MemberUserIds",
        "Name"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "description": "The description for the team."
        },
        "ExternalSecurityGroups": {
          "type": "array",
          "description": "The externally-managed security groups (e.g., Active Directory groups) who will belong to the team.",
          "items": {
            "$ref": "#/definitions/NamedReferenceItem"
          }
        },
        "MemberUserIds": {
          "type": "array",
          "description": "The users who will belong to the team.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Users-1",
            "..."
          ]
        },
        "Name": {
          "type": "string",
          "description": "The name of the team.",
          "maxLength": 200,
          "minLength": 1
        },
        "Slug": {
          "type": "string",
          "description": "The slug of the team."
        },
        "SpaceId": {
          "type": "string",
          "description": "The space in which to create the team.",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "CreateTenantCommand": {
      "type": "object",
      "description": "Creates a new Tenant, optionally cloning an existing tenant if the clone query string parameter is provided.",
      "required": [
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Clone": {
          "type": "string",
          "description": "The ID of the Tenant to clone. Example: Tenants-101.",
          "example": "Tenants-1"
        },
        "Description": {
          "type": "string"
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectEnvironments": {
          "type": "object",
          "description": "The projects the tenant is connected to, as an object keyed by project ID where each value is the array of environment IDs the tenant can deploy to for that project. Example: {\"Projects-1\": [\"Environments-1\", \"Environments-2\"]}.",
          "additionalProperties": {
            "type": "array",
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          }
        },
        "Slug": {
          "type": "string",
          "description": "A URL-friendly, unique identifier for the tenant. Generated from the name when omitted, which is usually what you want."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantTags": {
          "type": "array",
          "description": "Tags to apply to the tenant, as canonical tag names in the form 'TagSetName/TagName'. Example: [\"Regions/EU-West\", \"Tier/Premium\"]. Only tags from tenant-scoped tag sets are valid.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "CreateUserApiKeyCommand": {
      "type": "object",
      "description": "The API Key returned in the result must be saved by the caller, as it cannot be retrieved subsequently from the Octopus server",
      "required": [
        "UserId"
      ],
      "properties": {
        "ActorType": {
          "type": "string",
          "description": "The kind of actor that will hold this API key. Defaults to User when omitted.",
          "enum": [
            "User",
            "AiAgent"
          ]
        },
        "Expires": {
          "type": "string",
          "description": "The date after which the API key ceases to be usable. Provide a null value to create an API key with the maximum allowable expiry. If unspecified, will use the system default which is 180 days unless otherwise configured.",
          "format": "date-time"
        },
        "Purpose": {
          "type": "string",
          "description": "Informational text specifying the intended usage of the api key."
        },
        "UserId": {
          "type": "string",
          "description": "ID of the user",
          "example": "Users-1"
        }
      },
      "additionalProperties": false
    },
    "CreateUserCommand": {
      "type": "object",
      "required": [
        "DisplayName",
        "Username"
      ],
      "properties": {
        "DisplayName": {
          "type": "string",
          "minLength": 1
        },
        "EmailAddress": {
          "type": "string"
        },
        "Identities": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/IdentityResource"
          }
        },
        "IsActive": {
          "type": "boolean"
        },
        "IsService": {
          "type": "boolean"
        },
        "Password": {
          "type": "string"
        },
        "ServiceAccountType": {
          "type": "string",
          "enum": [
            "Standard",
            "Agent"
          ]
        },
        "Username": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "CreateUserRoleCommand": {
      "type": "object",
      "required": [
        "Name"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "GrantedSpacePermissions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "AdministerSystem",
              "ProjectEdit",
              "ProjectView",
              "ProjectCreate",
              "ProjectDelete",
              "ProcessView",
              "ProcessEdit",
              "VariableEdit",
              "VariableEditUnscoped",
              "VariableView",
              "VariableViewUnscoped",
              "ReleaseCreate",
              "ReleaseView",
              "ReleaseEdit",
              "ReleaseDelete",
              "DefectReport",
              "DefectResolve",
              "DeploymentCreate",
              "DeploymentDelete",
              "DeploymentView",
              "EnvironmentView",
              "EnvironmentCreate",
              "EnvironmentEdit",
              "EnvironmentDelete",
              "MachineCreate",
              "MachineEdit",
              "MachineView",
              "MachineDelete",
              "ArtifactView",
              "ArtifactCreate",
              "ArtifactEdit",
              "ArtifactDelete",
              "FeedView",
              "EventView",
              "LibraryVariableSetView",
              "LibraryVariableSetCreate",
              "LibraryVariableSetEdit",
              "LibraryVariableSetDelete",
              "ProjectGroupView",
              "ProjectGroupCreate",
              "ProjectGroupEdit",
              "ProjectGroupDelete",
              "TeamCreate",
              "TeamView",
              "TeamEdit",
              "TeamDelete",
              "UserView",
              "UserInvite",
              "UserRoleView",
              "UserRoleEdit",
              "TaskView",
              "TaskCreate",
              "TaskCancel",
              "TaskEdit",
              "TaskPrioritize",
              "InterruptionView",
              "InterruptionSubmit",
              "InterruptionViewSubmitResponsible",
              "BuiltInFeedPush",
              "BuiltInFeedAdminister",
              "BuiltInFeedDownload",
              "ActionTemplateView",
              "ActionTemplateCreate",
              "ActionTemplateEdit",
              "ActionTemplateDelete",
              "LifecycleCreate",
              "LifecycleView",
              "LifecycleEdit",
              "LifecycleDelete",
              "AccountView",
              "AccountEdit",
              "AccountCreate",
              "AccountDelete",
              "TenantCreate",
              "TenantEdit",
              "TenantView",
              "TenantDelete",
              "TagSetCreate",
              "TagSetEdit",
              "TagSetDelete",
              "TelemetryView",
              "MachinePolicyCreate",
              "MachinePolicyView",
              "MachinePolicyEdit",
              "MachinePolicyDelete",
              "ProxyCreate",
              "ProxyView",
              "ProxyEdit",
              "ProxyDelete",
              "SubscriptionCreate",
              "SubscriptionView",
              "SubscriptionEdit",
              "SubscriptionDelete",
              "TriggerCreate",
              "TriggerView",
              "TriggerEdit",
              "TriggerDelete",
              "CertificateView",
              "CertificateCreate",
              "CertificateEdit",
              "CertificateDelete",
              "CertificateExportPrivateKey",
              "UserEdit",
              "ConfigureServer",
              "FeedEdit",
              "WorkerView",
              "WorkerEdit",
              "SpaceEdit",
              "SpaceView",
              "SpaceDelete",
              "SpaceCreate",
              "BuildInformationPush",
              "BuildInformationAdminister",
              "RunbookView",
              "RunbookEdit",
              "RunbookSnapshotCreate",
              "RunbookRunView",
              "RunbookRunDelete",
              "RunbookRunCreate",
              "GitCredentialView",
              "GitCredentialEdit",
              "EventRetentionDelete",
              "EventRetentionView",
              "InsightsReportView",
              "InsightsReportCreate",
              "InsightsReportEdit",
              "InsightsReportDelete",
              "DeploymentFreezeAdminister",
              "TargetTagView",
              "TargetTagAdminister",
              "PlatformHubView",
              "PlatformHubEdit",
              "RetentionAdminister",
              "FeatureToggleEdit",
              "ApprovalPolicyAdminister",
              "SshKnownHostsAdminister",
              "SshKnownHostsView",
              "AiAgentTranscriptView",
              "DeployedResourceAdminister"
            ]
          }
        },
        "GrantedSystemPermissions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "AdministerSystem",
              "ProjectEdit",
              "ProjectView",
              "ProjectCreate",
              "ProjectDelete",
              "ProcessView",
              "ProcessEdit",
              "VariableEdit",
              "VariableEditUnscoped",
              "VariableView",
              "VariableViewUnscoped",
              "ReleaseCreate",
              "ReleaseView",
              "ReleaseEdit",
              "ReleaseDelete",
              "DefectReport",
              "DefectResolve",
              "DeploymentCreate",
              "DeploymentDelete",
              "DeploymentView",
              "EnvironmentView",
              "EnvironmentCreate",
              "EnvironmentEdit",
              "EnvironmentDelete",
              "MachineCreate",
              "MachineEdit",
              "MachineView",
              "MachineDelete",
              "ArtifactView",
              "ArtifactCreate",
              "ArtifactEdit",
              "ArtifactDelete",
              "FeedView",
              "EventView",
              "LibraryVariableSetView",
              "LibraryVariableSetCreate",
              "LibraryVariableSetEdit",
              "LibraryVariableSetDelete",
              "ProjectGroupView",
              "ProjectGroupCreate",
              "ProjectGroupEdit",
              "ProjectGroupDelete",
              "TeamCreate",
              "TeamView",
              "TeamEdit",
              "TeamDelete",
              "UserView",
              "UserInvite",
              "UserRoleView",
              "UserRoleEdit",
              "TaskView",
              "TaskCreate",
              "TaskCancel",
              "TaskEdit",
              "TaskPrioritize",
              "InterruptionView",
              "InterruptionSubmit",
              "InterruptionViewSubmitResponsible",
              "BuiltInFeedPush",
              "BuiltInFeedAdminister",
              "BuiltInFeedDownload",
              "ActionTemplateView",
              "ActionTemplateCreate",
              "ActionTemplateEdit",
              "ActionTemplateDelete",
              "LifecycleCreate",
              "LifecycleView",
              "LifecycleEdit",
              "LifecycleDelete",
              "AccountView",
              "AccountEdit",
              "AccountCreate",
              "AccountDelete",
              "TenantCreate",
              "TenantEdit",
              "TenantView",
              "TenantDelete",
              "TagSetCreate",
              "TagSetEdit",
              "TagSetDelete",
              "TelemetryView",
              "MachinePolicyCreate",
              "MachinePolicyView",
              "MachinePolicyEdit",
              "MachinePolicyDelete",
              "ProxyCreate",
              "ProxyView",
              "ProxyEdit",
              "ProxyDelete",
              "SubscriptionCreate",
              "SubscriptionView",
              "SubscriptionEdit",
              "SubscriptionDelete",
              "TriggerCreate",
              "TriggerView",
              "TriggerEdit",
              "TriggerDelete",
              "CertificateView",
              "CertificateCreate",
              "CertificateEdit",
              "CertificateDelete",
              "CertificateExportPrivateKey",
              "UserEdit",
              "ConfigureServer",
              "FeedEdit",
              "WorkerView",
              "WorkerEdit",
              "SpaceEdit",
              "SpaceView",
              "SpaceDelete",
              "SpaceCreate",
              "BuildInformationPush",
              "BuildInformationAdminister",
              "RunbookView",
              "RunbookEdit",
              "RunbookSnapshotCreate",
              "RunbookRunView",
              "RunbookRunDelete",
              "RunbookRunCreate",
              "GitCredentialView",
              "GitCredentialEdit",
              "EventRetentionDelete",
              "EventRetentionView",
              "InsightsReportView",
              "InsightsReportCreate",
              "InsightsReportEdit",
              "InsightsReportDelete",
              "DeploymentFreezeAdminister",
              "TargetTagView",
              "TargetTagAdminister",
              "PlatformHubView",
              "PlatformHubEdit",
              "RetentionAdminister",
              "FeatureToggleEdit",
              "ApprovalPolicyAdminister",
              "SshKnownHostsAdminister",
              "SshKnownHostsView",
              "AiAgentTranscriptView",
              "DeployedResourceAdminister"
            ]
          }
        },
        "Name": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "CreateWorkerCommand": {
      "type": "object",
      "required": [
        "Endpoint",
        "IsDisabled",
        "Name",
        "SpaceId",
        "WorkerPoolIds"
      ],
      "properties": {
        "Endpoint": {
          "$ref": "#/definitions/EndpointResource"
        },
        "IsDisabled": {
          "type": "boolean",
          "description": "Whether the worker is disabled or not"
        },
        "MachinePolicyId": {
          "type": "string",
          "description": "The policy the worker must adhere to",
          "example": "MachinePolicies-1"
        },
        "Name": {
          "type": "string",
          "description": "The name of the worker",
          "minLength": 1
        },
        "SkipInitialHealthCheck": {
          "type": "boolean"
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        },
        "WorkerPoolIds": {
          "type": "array",
          "description": "The worker pools the worker belongs to",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "WorkerPools-1",
            "..."
          ]
        }
      },
      "additionalProperties": false
    },
    "CreateWorkerPoolCommand": {
      "type": "object",
      "required": [
        "Name",
        "SpaceId",
        "WorkerPoolType"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "description": "Gets or sets a short description of this pool that can be used to explain the purpose of the pool to other users. May describe the kinds of machines in the pool. This field may contain markdown."
        },
        "IsDefault": {
          "type": "boolean",
          "description": "Is this the default pool. The default pool is used for steps that don't specify a worker pool. The default pool, if empty, uses the builtin worker to run steps."
        },
        "Name": {
          "type": "string",
          "description": "Gets or sets the name of this pool. This should be short, preferably 5-20 characters.",
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        },
        "SortOrder": {
          "type": "integer",
          "description": "Gets or sets a number indicating the priority of this pool in sort order. Pools with a lower sort order will appear in the UI before items with a higher sort order.",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "WorkerPoolType": {
          "type": "string",
          "enum": [
            "StaticWorkerPool",
            "DynamicWorkerPool"
          ]
        },
        "WorkerType": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "DashboardConfigurationResource": {
      "type": "object",
      "properties": {
        "HideInactiveProjects": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IncludedEnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "IncludedEnvironmentTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "IncludedProjectGroupIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "IncludedProjectIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Projects-1",
            "..."
          ]
        },
        "IncludedProjectTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "IncludedTenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "IncludedTenantTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectLimit": {
          "type": "integer",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "DashboardEnvironmentResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "DashboardItemResource": {
      "type": "object",
      "properties": {
        "ChannelId": {
          "type": "string",
          "example": "Channels-1"
        },
        "CompletedTime": {
          "type": "string",
          "format": "date-time"
        },
        "Created": {
          "type": "string",
          "format": "date-time"
        },
        "DeploymentId": {
          "type": "string",
          "example": "Deployments-1"
        },
        "Duration": {
          "type": "string"
        },
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "ErrorMessage": {
          "type": "string"
        },
        "HasPendingInterruptions": {
          "type": "boolean",
          "readOnly": true
        },
        "HasPendingPreconditions": {
          "type": "boolean",
          "readOnly": true
        },
        "HasWarningsOrErrors": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource.",
          "example": "Deployments-1"
        },
        "IsCompleted": {
          "type": "boolean"
        },
        "IsCurrent": {
          "type": "boolean"
        },
        "IsPrevious": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "PendingInterruptionTypes": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "ManualIntervention",
              "GuidedFailure",
              "PullRequestCompletion",
              "ArgoCDApplicationSync",
              "KubernetesResourceVerification"
            ]
          }
        },
        "PendingPreconditionTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "QueueTime": {
          "type": "string",
          "format": "date-time"
        },
        "ReleaseId": {
          "type": "string",
          "example": "Releases-1"
        },
        "ReleaseVersion": {
          "type": "string"
        },
        "StartTime": {
          "type": "string",
          "format": "date-time"
        },
        "State": {
          "type": "string",
          "enum": [
            "Queued",
            "Executing",
            "Failed",
            "Canceled",
            "TimedOut",
            "Success",
            "Cancelling"
          ]
        },
        "TaskId": {
          "type": "string"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        }
      },
      "additionalProperties": false
    },
    "DashboardProjectGroupResource": {
      "type": "object",
      "properties": {
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "DashboardProjectResource": {
      "type": "object",
      "properties": {
        "CanPerformUntenantedDeployment": {
          "type": "boolean"
        },
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "ProjectGroupId": {
          "type": "string"
        },
        "Slug": {
          "type": "string"
        },
        "TenantedDeploymentMode": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        }
      },
      "additionalProperties": false
    },
    "DashboardResource": {
      "type": "object",
      "properties": {
        "Environments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DashboardEnvironmentResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsFiltered": {
          "type": "boolean"
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DashboardItemResource"
          }
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectGroups": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DashboardProjectGroupResource"
          }
        },
        "ProjectLimit": {
          "type": "integer",
          "format": "int32"
        },
        "Projects": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DashboardProjectResource"
          }
        },
        "Tenants": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DashboardTenantResource"
          }
        }
      },
      "additionalProperties": false
    },
    "DashboardTenantResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "ProjectEnvironments": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          }
        },
        "TenantTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "DeauthorizeGitHubAppResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DefectResource": {
      "type": "object",
      "required": [
        "Description"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Status": {
          "type": "string",
          "enum": [
            "Unresolved",
            "Resolved"
          ]
        }
      },
      "additionalProperties": false
    },
    "DefectResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DefectResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "DeleteAccountResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteActionTemplateByIdResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteApprovalRuleResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteArchivedEventFileResponse": {
      "type": "object",
      "required": [
        "FileName"
      ],
      "properties": {
        "FileName": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "DeleteChannelResponseV2": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteConnectionAgentForwardingRuleCommand": {
      "type": "object",
      "required": [
        "Fqdn"
      ],
      "properties": {
        "Fqdn": {
          "type": "string",
          "description": "The FQDN of the forwarding rule to delete.",
          "maxLength": 253,
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "DeleteConnectionAgentForwardingRuleResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteConnectionAgentRegistrationResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteFeatureToggleResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteGitCredentialResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteGitHubAppConnectionByIdResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteInsightsReportResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteKubernetesMonitorByIdResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteLifecycleResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteMachinePolicyResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteOctopusServerNodeResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeletePackageResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeletePlatformHubAccountResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeletePlatformHubCertificateResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeletePlatformHubFeedResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeletePlatformHubGitCredentialResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeletePlatformHubGitHubAppConnectionByIdResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteProcessTemplateCommand": {
      "type": "object",
      "required": [
        "GitRef",
        "Slug"
      ],
      "properties": {
        "ChangeDescription": {
          "type": "string"
        },
        "GitRef": {
          "type": "string"
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "DeleteProjectTriggerResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteRolloutGroupResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteRunbookInGitCommand": {
      "type": "object",
      "required": [
        "GitRef",
        "Id",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "ChangeDescription": {
          "type": "string",
          "description": "The commit message for updating the Git repository"
        },
        "GitRef": {
          "type": "string",
          "description": "The GitRef containing the resource(s)"
        },
        "Id": {
          "type": "string",
          "description": "ID of the Runbook to delete",
          "example": "Runbooks-1"
        },
        "ProjectId": {
          "type": "string",
          "description": "The ID of the project",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "DeleteServiceAccountOidcIdentityResponseV1": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteSpaceResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteSshKnownHostResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteSubscriptionResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeleteUserApiKeyByIdResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "DeploymentActionContainerResource": {
      "type": "object",
      "properties": {
        "Dockerfile": {
          "type": "string"
        },
        "FeedId": {
          "type": "string"
        },
        "GitUrl": {
          "type": "string"
        },
        "Image": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "DeploymentActionGitDependencyResource": {
      "type": "object",
      "required": [
        "DeploymentActionSlug",
        "GitDependencyName"
      ],
      "properties": {
        "DeploymentActionSlug": {
          "type": "string",
          "description": "The slug of the deployment action"
        },
        "GitDependencyName": {
          "type": "string",
          "description": "The name of the git dependency"
        }
      },
      "additionalProperties": false
    },
    "DeploymentActionPackageResource": {
      "type": "object",
      "properties": {
        "DeploymentAction": {
          "type": "string",
          "description": "The name or ID of the deployment action"
        },
        "PackageReference": {
          "type": "string",
          "description": "The name or ID of the package reference"
        }
      },
      "additionalProperties": false
    },
    "DeploymentActionResource": {
      "type": "object",
      "properties": {
        "ActionType": {
          "type": "string"
        },
        "AvailableStepPackageVersions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "CanBeUsedForProjectVersioning": {
          "type": "boolean"
        },
        "Channels": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "ChannelsVariable": {
          "type": "string"
        },
        "CommunityActionTemplateSnapshot": {
          "$ref": "#/definitions/CommunityActionTemplateSnapshotResource"
        },
        "Condition": {
          "type": "string",
          "enum": [
            "Success",
            "Variable"
          ]
        },
        "Container": {
          "$ref": "#/definitions/DeploymentActionContainerResource"
        },
        "Environments": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "EnvironmentsVariable": {
          "type": "string"
        },
        "ExcludedEnvironments": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "ExcludedEnvironmentsVariable": {
          "type": "string"
        },
        "GitDependencies": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitDependencyResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Inputs": {
          "$ref": "#/definitions/StepPackageInputsResource"
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "IsRequired": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastSavedStepPackageVersion": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "Notes": {
          "type": "string"
        },
        "Packages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PackageReferenceResource"
          }
        },
        "Properties": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/PropertyValueResource"
          },
          "readOnly": true
        },
        "Slug": {
          "type": "string"
        },
        "StepPackageVersion": {
          "type": "string"
        },
        "TenantTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "TenantTagsVariable": {
          "type": "string"
        },
        "WorkerPoolId": {
          "type": "string"
        },
        "WorkerPoolVariable": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "DeploymentConnectivityPolicy": {
      "type": "object",
      "properties": {
        "AllowDeploymentsToNoTargets": {
          "type": "boolean"
        },
        "ExcludeUnhealthyTargets": {
          "type": "boolean"
        },
        "SkipMachineBehavior": {
          "type": "string",
          "enum": [
            "None",
            "SkipUnavailableMachines"
          ]
        },
        "TargetRoles": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "DeploymentEnvironmentSettingsMetadata": {
      "type": "object",
      "properties": {
        "ExtensionId": {
          "type": "string"
        },
        "Metadata": {
          "$ref": "#/definitions/Metadata"
        }
      },
      "additionalProperties": false
    },
    "DeploymentFreezeResource": {
      "type": "object",
      "required": [
        "End",
        "Id",
        "Name",
        "ProjectEnvironmentScope",
        "Start"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "End": {
          "type": "string",
          "format": "date-time"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectEnvironmentScope": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          }
        },
        "RecurringSchedule": {
          "$ref": "#/definitions/RecurringScheduleResource"
        },
        "Start": {
          "type": "string",
          "format": "date-time"
        },
        "TenantProjectEnvironmentScope": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "$ref": "#/definitions/TenantProjectEnvironment"
          }
        }
      },
      "additionalProperties": false
    },
    "DeploymentPreviewRequest": {
      "type": "object",
      "properties": {
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        }
      },
      "additionalProperties": false
    },
    "DeploymentPreviewResource": {
      "type": "object",
      "properties": {
        "Changes": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseChangesResource"
          }
        },
        "ChangesMarkdown": {
          "type": "string"
        },
        "Form": {
          "$ref": "#/definitions/Form"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "StepsToExecute": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentTemplateStep"
          }
        },
        "UseGuidedFailureModeByDefault": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "DeploymentProcessResource": {
      "type": "object",
      "required": [
        "Steps",
        "Version"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastSnapshotId": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Steps": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentStepResource"
          }
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "DeploymentProcessResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentProcessResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "DeploymentPromotionTarget": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "example": "Environments-1"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "DeploymentPromotionTenant": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "PromoteTo": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentPromotionTarget"
          }
        }
      },
      "additionalProperties": false
    },
    "DeploymentResource": {
      "type": "object",
      "required": [
        "EnvironmentId",
        "ReleaseId"
      ],
      "properties": {
        "ChangeRequestSettings": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ChangeRequestSettings"
          }
        },
        "Changes": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseChangesResource"
          }
        },
        "ChangesMarkdown": {
          "type": "string"
        },
        "ChannelId": {
          "type": "string",
          "example": "Channels-1"
        },
        "Comments": {
          "type": "string"
        },
        "Created": {
          "type": "string",
          "format": "date-time"
        },
        "DebugMode": {
          "type": "string"
        },
        "DeployedBy": {
          "type": "string"
        },
        "DeployedById": {
          "type": "string"
        },
        "DeployedToMachineIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "DeploymentProcessId": {
          "type": "string"
        },
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "ExcludedMachineIds": {
          "type": "array",
          "description": "A collection of machines in the target environment that should be excluded from the deployment.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ExcludedTargetTagIds": {
          "type": "array",
          "description": "A collection of target tag IDs that should be excluded from the deployment. Only deployment targets that have none of these tags will be deployed to. Tag IDs are in the format \"TagSets-{id}/Tags-{id}\".",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ExecutionPlanLogContext": {
          "$ref": "#/definitions/ExecutionPlanLogContext"
        },
        "FailTargetDiscovery": {
          "type": "boolean"
        },
        "FailureEncountered": {
          "type": "boolean"
        },
        "ForcePackageDownload": {
          "type": "boolean"
        },
        "ForcePackageRedeployment": {
          "type": "boolean"
        },
        "FormValues": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource.",
          "example": "Deployments-1"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ManifestVariableSetId": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "Priority": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "QueueTime": {
          "type": "string",
          "description": "If set this time will be the used to schedule the deployment to a later time, null is assumed to mean the time will be executed immediately.",
          "format": "date-time"
        },
        "QueueTimeExpiry": {
          "type": "string",
          "format": "date-time"
        },
        "ReleaseId": {
          "type": "string",
          "example": "Releases-1"
        },
        "SkipActions": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "SpecificMachineIds": {
          "type": "array",
          "description": "A collection of machines in the target environment that should be deployed to. If the collection is empty, all enabled machines are deployed.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpecificTargetTagIds": {
          "type": "array",
          "description": "A collection of target tag IDs that should be included in the deployment. Only deployment targets that have at least one of these tags will be deployed to. Tag IDs are in the format \"TagSets-{id}/Tags-{id}\".",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "TaskId": {
          "type": "string",
          "example": "ServerTasks-1"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        },
        "TentacleRetentionPeriod": {
          "$ref": "#/definitions/RetentionPeriod"
        },
        "UseGuidedFailure": {
          "type": "boolean",
          "description": "If set to true, the deployment will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable."
        }
      },
      "additionalProperties": false
    },
    "DeploymentResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "DeploymentServerTask": {
      "type": "object",
      "required": [
        "DeploymentId",
        "ServerTaskId"
      ],
      "properties": {
        "DeploymentId": {
          "type": "string",
          "example": "Deployments-1"
        },
        "ServerTaskId": {
          "type": "string",
          "example": "ServerTasks-1"
        }
      },
      "additionalProperties": false
    },
    "DeploymentSettingsResource": {
      "type": "object",
      "properties": {
        "CancelQueuedTasks": {
          "type": "boolean"
        },
        "CancelRunningTasks": {
          "type": "boolean"
        },
        "ConnectivityPolicy": {
          "$ref": "#/definitions/DeploymentConnectivityPolicy"
        },
        "DefaultGuidedFailureMode": {
          "type": "string",
          "enum": [
            "EnvironmentDefault",
            "Off",
            "On"
          ]
        },
        "DefaultToSkipIfAlreadyInstalled": {
          "type": "boolean"
        },
        "DeploymentChangesTemplate": {
          "type": "string"
        },
        "FailTargetDiscovery": {
          "type": "boolean"
        },
        "ForcePackageDownload": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ReleaseNotesTemplate": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "VersioningStrategy": {
          "$ref": "#/definitions/VersioningStrategyResource"
        }
      },
      "additionalProperties": false
    },
    "DeploymentStepResource": {
      "type": "object",
      "required": [
        "Name"
      ],
      "properties": {
        "Actions": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentActionResource"
          }
        },
        "Condition": {
          "type": "string",
          "enum": [
            "Success",
            "Failure",
            "Always",
            "Variable"
          ]
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "PackageRequirement": {
          "type": "string",
          "enum": [
            "LetOctopusDecide",
            "BeforePackageAcquisition",
            "AfterPackageAcquisition"
          ]
        },
        "Properties": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/PropertyValueResource"
          }
        },
        "Slug": {
          "type": "string"
        },
        "StartTrigger": {
          "type": "string",
          "enum": [
            "StartAfterPrevious",
            "StartWithPrevious",
            "Variable"
          ]
        },
        "Type": {
          "type": "string",
          "description": "Either \"Step\" or \"ProcessTemplateUsage\". Defaults to \"Step\" if no type is provided.",
          "readOnly": true
        }
      },
      "additionalProperties": false
    },
    "DeploymentTargetTagResource": {
      "type": "object",
      "required": [
        "SpaceId",
        "Tag"
      ],
      "properties": {
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Tag": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "DeploymentTemplateResource": {
      "type": "object",
      "properties": {
        "DeploymentNotes": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDeploymentProcessModified": {
          "type": "boolean"
        },
        "IsGitResourceModified": {
          "type": "boolean"
        },
        "IsLibraryVariableSetModified": {
          "type": "boolean"
        },
        "IsVariableSetModified": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "PromoteTo": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentPromotionTarget"
          }
        },
        "TenantPromotions": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentPromotionTenant"
          }
        }
      },
      "additionalProperties": false
    },
    "DeploymentTemplateStep": {
      "type": "object",
      "properties": {
        "ActionId": {
          "type": "string"
        },
        "ActionName": {
          "type": "string"
        },
        "ActionNumber": {
          "type": "string"
        },
        "AvailableTagSets": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TagSetPreview"
          }
        },
        "CanBeSkipped": {
          "type": "boolean"
        },
        "ExcludedMachines": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        },
        "HasNoApplicableMachines": {
          "type": "boolean"
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "MachineNames": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Machines": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/MachineDeploymentPreview"
          }
        },
        "Roles": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "UnavailableMachines": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        }
      },
      "additionalProperties": false
    },
    "DeprovisionEphemeralEnvironmentForProjectResponse": {
      "type": "object",
      "properties": {
        "DeprovisioningRun": {
          "$ref": "#/definitions/EphemeralEnvironmentRunbookRun"
        }
      },
      "additionalProperties": false
    },
    "DeprovisionEphemeralEnvironmentResponse": {
      "type": "object",
      "required": [
        "DeprovisioningRuns"
      ],
      "properties": {
        "DeprovisioningRuns": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/EphemeralEnvironmentRunbookRun"
          }
        }
      },
      "additionalProperties": false
    },
    "DisplayInfo": {
      "type": "object",
      "properties": {
        "Category": {
          "type": "string"
        },
        "ConnectivityCheck": {
          "$ref": "#/definitions/ConnectivityCheck"
        },
        "Description": {
          "type": "string"
        },
        "ExtendedDescription": {
          "type": "string"
        },
        "Label": {
          "type": "string"
        },
        "ListApi": {
          "$ref": "#/definitions/ListApiMetadata"
        },
        "Options": {
          "$ref": "#/definitions/OptionsMetadata"
        },
        "PropertyApplicability": {
          "$ref": "#/definitions/PropertyApplicability"
        },
        "ReadOnly": {
          "type": "boolean"
        },
        "Required": {
          "type": "boolean"
        },
        "ShowCopyToClipboard": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "DocumentTypeResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "DoubleMetric": {
      "type": "object",
      "properties": {
        "Count": {
          "type": "integer",
          "format": "int32"
        },
        "Max": {
          "type": "number",
          "format": "double"
        },
        "Mean": {
          "type": "number",
          "format": "double"
        },
        "Median": {
          "type": "number",
          "format": "double"
        },
        "Min": {
          "type": "number",
          "format": "double"
        },
        "NinetyFifth": {
          "type": "number",
          "format": "double"
        }
      },
      "additionalProperties": false
    },
    "DurationMetric": {
      "type": "object",
      "properties": {
        "Count": {
          "type": "integer",
          "format": "int32"
        },
        "Max": {
          "type": "string"
        },
        "Mean": {
          "type": "string"
        },
        "Median": {
          "type": "string"
        },
        "Min": {
          "type": "string"
        },
        "NinetyFifth": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "DynamicExtensionsFeature": {
      "type": "object",
      "properties": {
        "Default": {
          "type": "string"
        },
        "Description": {
          "type": "string",
          "description": "Markdown formatted."
        },
        "Key": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "Options": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "DynamicExtensionsFeaturesMetadataResource": {
      "type": "object",
      "properties": {
        "Features": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DynamicExtensionsFeature"
          }
        }
      },
      "additionalProperties": false
    },
    "DynamicExtensionsFeaturesValuesResource": {
      "type": "object",
      "properties": {
        "Values": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "DynamicWorkerType": {
      "type": "object",
      "properties": {
        "DeprecationDateUtc": {
          "type": "string",
          "format": "date-time"
        },
        "Description": {
          "type": "string"
        },
        "EndOfLifeDateUtc": {
          "type": "string",
          "format": "date-time"
        },
        "Id": {
          "type": "string"
        },
        "StartDateUtc": {
          "type": "string",
          "format": "date-time"
        },
        "Type": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "EndpointResource": {
      "type": "object",
      "properties": {
        "CommunicationStyle": {
          "type": "string",
          "description": "This is for legacy support in client. Server no longer uses this for determining endpoint types, it uses DeploymentTargetType",
          "enum": [
            "None",
            "TentaclePassive",
            "TentacleActive",
            "Ssh",
            "OfflineDrop",
            "AzureWebApp",
            "Ftp",
            "AzureCloudService",
            "AzureServiceFabricCluster",
            "Kubernetes",
            "StepPackage",
            "KubernetesTentacle",
            "AwsEcsCluster"
          ],
          "readOnly": true
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "EnvironmentResource": {
      "type": "object",
      "properties": {
        "AllowDynamicInfrastructure": {
          "type": "boolean",
          "description": "If set to true, deployments to this environment will be allowed to contain steps that manage infrastructure. This relies on DeploymentActionResource being set to allow managing resource for a step"
        },
        "Description": {
          "type": "string",
          "description": "Gets or sets a short description of this environment that can be used to explain the purpose of the environment to other users. This field may contain markdown."
        },
        "EnvironmentTags": {
          "type": "array",
          "description": "List of tags assigned to this environment",
          "items": {
            "type": "string"
          }
        },
        "ExtensionSettings": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ExtensionSettingsValues"
          },
          "readOnly": true
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "description": "Gets or sets the name of this environment. This should be short, preferably 5-20 characters."
        },
        "Slug": {
          "type": "string"
        },
        "SortOrder": {
          "type": "integer",
          "description": "Gets or sets a number indicating the priority of this environment in sort order. Environments with a lower sort order will appear in the UI before items with a higher sort order.",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "UseGuidedFailure": {
          "type": "boolean",
          "description": "If set to true, deployments will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable."
        }
      },
      "additionalProperties": false
    },
    "EnvironmentResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/EnvironmentResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "EnvironmentsSummaryResource": {
      "type": "object",
      "properties": {
        "DeploymentTargetSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "EnvironmentSummaries": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/EnvironmentSummaryResource"
          }
        },
        "MachineEndpointSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineHealthStatusSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineIdsForCalamariUpgrade": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "MachineIdsForTentacleUpgrade": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "MachineTenantSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineTenantTagSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "TentacleUpgradesRequired": {
          "type": "boolean"
        },
        "TotalDisabledMachines": {
          "type": "integer",
          "format": "int32"
        },
        "TotalMachines": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "EnvironmentSummaryResource": {
      "type": "object",
      "properties": {
        "DeploymentTargetSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "Environment": {
          "$ref": "#/definitions/EnvironmentResource"
        },
        "MachineEndpointSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineHealthStatusSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineIdsForCalamariUpgrade": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "MachineIdsForTentacleUpgrade": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "MachineTenantSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineTenantTagSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "TentacleUpgradesRequired": {
          "type": "boolean"
        },
        "TotalDisabledMachines": {
          "type": "integer",
          "format": "int32"
        },
        "TotalMachines": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "EnvironmentSummaryV2Resource": {
      "type": "object",
      "properties": {
        "DeploymentTargetSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "Environment": {
          "$ref": "#/definitions/BaseEnvironmentV2Resource"
        },
        "MachineEndpointSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineHealthStatusSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineIdsForCalamariUpgrade": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "MachineIdsForTentacleUpgrade": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "MachineTenantSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineTenantTagSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "TentacleUpgradesRequired": {
          "type": "boolean"
        },
        "TotalDisabledMachines": {
          "type": "integer",
          "format": "int32"
        },
        "TotalMachines": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "EnvironmentUrlResource": {
      "type": "object",
      "properties": {
        "Name": {
          "type": "string"
        },
        "Url": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "EphemeralEnvironmentRunbookRun": {
      "type": "object",
      "required": [
        "RunbookRunId",
        "TaskId"
      ],
      "properties": {
        "RunbookRunId": {
          "type": "string",
          "example": "RunbookRuns-1"
        },
        "TaskId": {
          "type": "string",
          "example": "ServerTasks-1"
        }
      },
      "additionalProperties": false
    },
    "Error": {
      "type": "object",
      "properties": {
        "Details": { },
        "ErrorMessage": {
          "type": "string"
        },
        "Errors": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "FullException": {
          "type": "string"
        },
        "HelpLink": {
          "type": "string"
        },
        "HelpText": {
          "type": "string"
        },
        "ParsedHelpLinks": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "EventAgentResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "EventCategoryResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "EventGroupResource": {
      "type": "object",
      "properties": {
        "EventCategories": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Id": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "EventNotificationSubscriptionFilterResource": {
      "type": "object",
      "properties": {
        "DocumentTypes": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Environments": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "EventAgents": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "EventCategories": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "EventGroups": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ProjectGroups": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Projects": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Tags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Tenants": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "Users": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "EventNotificationSubscriptionResource": {
      "type": "object",
      "properties": {
        "EmailDigestLastProcessed": {
          "type": "string",
          "format": "date-time"
        },
        "EmailDigestLastProcessedEventAutoId": {
          "type": "integer",
          "format": "int64"
        },
        "EmailFrequencyPeriod": {
          "type": "string",
          "format": "date-span"
        },
        "EmailPriority": {
          "type": "string",
          "enum": [
            "Normal",
            "Low",
            "High"
          ]
        },
        "EmailShowDatesInTimeZoneId": {
          "type": "string"
        },
        "EmailTeams": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Filter": {
          "$ref": "#/definitions/EventNotificationSubscriptionFilterResource"
        },
        "SlackChannelIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SlackChannelNames": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SlackDigestLastProcessed": {
          "type": "string",
          "format": "date-time"
        },
        "SlackDigestLastProcessedEventAutoId": {
          "type": "integer",
          "format": "int64"
        },
        "SlackFrequencyPeriod": {
          "type": "string",
          "format": "date-span"
        },
        "WebhookHeaderKey": {
          "type": "string"
        },
        "WebhookHeaderValue": {
          "$ref": "#/definitions/PropertyValueResource"
        },
        "WebhookLastProcessed": {
          "type": "string",
          "format": "date-time"
        },
        "WebhookLastProcessedEventAutoId": {
          "type": "integer",
          "format": "int64"
        },
        "WebhookTeams": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "WebhookTimeout": {
          "type": "string",
          "format": "date-span"
        },
        "WebhookURI": {
          "type": "string",
          "description": "Use a backing field here, so we can ignore empty strings, which the portal sends us",
          "format": "uri"
        }
      },
      "additionalProperties": false
    },
    "EventReference": {
      "type": "object",
      "properties": {
        "Length": {
          "type": "integer",
          "format": "int32"
        },
        "ReferencedDocumentId": {
          "type": "string"
        },
        "StartIndex": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "EventResource": {
      "type": "object",
      "properties": {
        "ApiKeyHint": {
          "type": "string",
          "description": "Gets or sets the obfuscated hint of the API key used to authenticate the request, if applicable."
        },
        "ApiKeyId": {
          "type": "string",
          "description": "Gets or sets the ID of the API key used to authenticate the request, if applicable."
        },
        "Category": {
          "type": "string",
          "description": "Gets or sets the event category."
        },
        "ChangeDetails": {
          "$ref": "#/definitions/ChangeDetailsResource"
        },
        "Comments": {
          "type": "string",
          "description": "Gets or sets any user-provided comments that were recorded with the event."
        },
        "Details": {
          "type": "string",
          "description": "Gets or sets the details of the event. For events representing a modification to a document use the ChangeDetails property."
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IdentityEstablishedWith": {
          "type": "string",
          "description": "Gets or sets a description of how the user performing the event identified themselves to Octopus."
        },
        "IpAddress": {
          "type": "string",
          "description": "The IP address of the user that created the event."
        },
        "IsService": {
          "type": "boolean",
          "description": "Gets or sets whether the user who created the event is a service user or an interactive user."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Message": {
          "type": "string",
          "description": "Gets or sets the message text that summarizes the event."
        },
        "MessageHtml": {
          "type": "string",
          "description": "Gets or sets the message text that summarizes the event, HTML formatted with links to the related documents."
        },
        "MessageReferences": {
          "type": "array",
          "description": "Gets or sets an array of document ID's and indexes where they are mentioned in the message text.",
          "items": {
            "$ref": "#/definitions/EventReference"
          }
        },
        "Occurred": {
          "type": "string",
          "description": "Gets or sets the date/time that the event took place.",
          "format": "date-time"
        },
        "RelatedDocumentIds": {
          "type": "array",
          "description": "Gets or sets a collection of document ID's that this event relates to. Note that the document ID's may no longer exist.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "description": "Gets or sets the SpaceId of the event. This represents the space in which the event was raised.",
          "example": "Spaces-1"
        },
        "UserAgent": {
          "type": "string",
          "description": "Gets or sets the user agent header value from the request that triggered the event"
        },
        "UserId": {
          "type": "string",
          "description": "Gets or sets the ID of the user who created the event."
        },
        "Username": {
          "type": "string",
          "description": "Gets or sets the name of the user who created the event."
        }
      },
      "additionalProperties": false
    },
    "ExchangeAccessCodeForTokenCommand": {
      "type": "object",
      "required": [
        "Code"
      ],
      "properties": {
        "Code": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ExchangeAccessCodeForTokenResponse": {
      "type": "object",
      "required": [
        "Status"
      ],
      "properties": {
        "ErrorMessage": {
          "type": "string"
        },
        "Status": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ExchangeOidcTokenForAccessTokenCommandV1": {
      "type": "object",
      "required": [
        "audience",
        "grant_type",
        "subject_token",
        "subject_token_type"
      ],
      "properties": {
        "audience": {
          "type": "string",
          "minLength": 1
        },
        "grant_type": {
          "type": "string",
          "minLength": 1
        },
        "subject_token": {
          "type": "string",
          "minLength": 1
        },
        "subject_token_type": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ExecutionPlanLogContext": {
      "type": "object",
      "required": [
        "Steps"
      ],
      "properties": {
        "Steps": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/StepLogContext"
          }
        }
      },
      "additionalProperties": false
    },
    "ExtensionSettingsValues": {
      "type": "object",
      "properties": {
        "ExtensionId": {
          "type": "string"
        },
        "Values": { }
      },
      "additionalProperties": false
    },
    "ExternalLinkResource": {
      "type": "object",
      "properties": {
        "Label": {
          "type": "string"
        },
        "Uri": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ExternalUserLookupResult": {
      "type": "object",
      "properties": {
        "Identities": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/IdentityResource"
          }
        }
      },
      "additionalProperties": false
    },
    "FeaturesConfigurationResource": {
      "type": "object",
      "properties": {
        "DefaultPowerShellEdition": {
          "type": "string"
        },
        "HelpSidebarSupportLink": {
          "type": "string"
        },
        "HelpSidebarSupportLinkLabel": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsAutomaticStepUpdatesEnabled": {
          "type": "boolean"
        },
        "IsBuiltInWorkerEnabled": {
          "type": "boolean"
        },
        "IsCommunityActionTemplatesEnabled": {
          "type": "boolean"
        },
        "IsCompositeDockerHubRegistryFeedEnabled": {
          "type": "boolean"
        },
        "IsConfigureFeedsWithLocalOrSmbPathsEnabled": {
          "type": "boolean"
        },
        "IsExperimentalUIFeatureEnabled": {
          "type": "boolean"
        },
        "IsGitHubAppEnabled": {
          "type": "boolean"
        },
        "IsHelpSidebarEnabled": {
          "type": "boolean"
        },
        "IsKubernetesCloudTargetDiscoveryEnabled": {
          "type": "boolean"
        },
        "IsProjectsPageOnboardingEnabled": {
          "type": "boolean"
        },
        "IsProjectsPageOptimizationEnabled": {
          "type": "boolean"
        },
        "IsWebhookTriggerEnabled": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "FeatureToggleEnvironmentResource": {
      "type": "object",
      "required": [
        "DeploymentEnvironmentId",
        "FeatureToggleId",
        "IsEnabled"
      ],
      "properties": {
        "ClientRolloutPercentage": {
          "type": "integer",
          "format": "int32"
        },
        "DeploymentEnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "ExcludedTenantIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "ExcludedTenantTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "FeatureToggleId": {
          "type": "string"
        },
        "IsEnabled": {
          "type": "boolean"
        },
        "MinimumVersion": {
          "type": "string",
          "maxLength": 200
        },
        "RolloutPercentage": {
          "type": "integer",
          "format": "int32"
        },
        "Segments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/StringStringKeyValuePair"
          }
        },
        "TenantIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "FeatureToggleResource": {
      "type": "object",
      "required": [
        "DefaultIsEnabled",
        "Environments",
        "Id",
        "Name",
        "ProjectId",
        "Slug",
        "SpaceId",
        "Tags"
      ],
      "properties": {
        "DefaultIsEnabled": {
          "type": "boolean"
        },
        "Description": {
          "type": "string"
        },
        "Environments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/FeatureToggleEnvironmentResource"
          }
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "RolloutGroupId": {
          "type": "string"
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "FeatureToggleResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/FeatureToggleResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "FeatureToggleUsage": {
      "type": "object",
      "required": [
        "Id",
        "Name"
      ],
      "properties": {
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "FeedResource": {
      "type": "object",
      "properties": {
        "FeedType": {
          "type": "string",
          "enum": [
            "None",
            "NuGet",
            "Docker",
            "Maven",
            "OctopusProject",
            "GitHub",
            "Helm",
            "OciRegistry",
            "AwsElasticContainerRegistry",
            "BuiltIn",
            "S3",
            "AzureContainerRegistry",
            "GoogleContainerRegistry",
            "ArtifactoryGeneric",
            "Npm",
            "GcsStorage",
            "PyPi"
          ],
          "readOnly": true
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "PackageAcquisitionLocationOptions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "Server",
              "ExecutionTarget",
              "NotAcquired"
            ]
          }
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "FeedResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/FeedResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "Form": {
      "type": "object",
      "properties": {
        "Elements": {
          "type": "array",
          "description": "Elements of the form.",
          "items": {
            "$ref": "#/definitions/FormElement"
          }
        },
        "Values": {
          "type": "object",
          "description": "Values supplied for the form elements.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "FormElement": {
      "type": "object",
      "properties": {
        "Control": {
          "$ref": "#/definitions/Control"
        },
        "IsValueRequired": {
          "type": "boolean",
          "description": "If true, the receiver of the form expects that a value will be provided for the element."
        },
        "Name": {
          "type": "string",
          "description": "The name of the element. Must be unique within the form."
        }
      },
      "additionalProperties": false
    },
    "GenerateAccessTokenResponse": {
      "type": "object",
      "required": [
        "AccessToken"
      ],
      "properties": {
        "AccessToken": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GenerateClientIdentifierCommand": {
      "type": "object",
      "required": [
        "EnvironmentId",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        }
      },
      "additionalProperties": false
    },
    "GenerateClientIdentifierResponse": {
      "type": "object",
      "required": [
        "ClientIdentifier"
      ],
      "properties": {
        "ClientIdentifier": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GeneratePendingSigningKeyResponseV1": {
      "type": "object",
      "required": [
        "Id"
      ],
      "properties": {
        "Id": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "GetAccountTypesResponse": {
      "type": "object",
      "required": [
        "AccountTypes"
      ],
      "properties": {
        "AccountTypes": {
          "type": "array",
          "description": "The supported account types, sorted by name. Each value is what an Account's AccountType is set to, and what the AccountType filter when listing accounts accepts.",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "GetActionTemplateByIdResponse": {
      "type": "object",
      "required": [
        "ActionTemplate"
      ],
      "properties": {
        "ActionTemplate": {
          "$ref": "#/definitions/ActionTemplateResource"
        }
      },
      "additionalProperties": false
    },
    "GetAllCompliancePoliciesResponse": {
      "type": "object",
      "required": [
        "FilteredItemsCount",
        "ItemsPerPage",
        "Policies",
        "TotalItemsCount"
      ],
      "properties": {
        "FilteredItemsCount": {
          "type": "integer",
          "format": "int32"
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "Policies": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CompliancePolicyResource"
          }
        },
        "TotalItemsCount": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GetAllDeploymentTargetsResponse": {
      "type": "object",
      "required": [
        "DeploymentTargets"
      ],
      "properties": {
        "DeploymentTargets": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/MachineResource"
          }
        }
      },
      "additionalProperties": false
    },
    "GetAllEnvironmentsResponse": {
      "type": "object",
      "required": [
        "Environments"
      ],
      "properties": {
        "Environments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/EnvironmentResource"
          }
        }
      },
      "additionalProperties": false
    },
    "GetAllIconsResponse": {
      "type": "object",
      "required": [
        "icons"
      ],
      "properties": {
        "icons": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/IconDetail"
          }
        }
      },
      "additionalProperties": false
    },
    "GetAllLibraryVariableSetsResponse": {
      "type": "object",
      "required": [
        "LibraryVariableSets"
      ],
      "properties": {
        "LibraryVariableSets": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/LibraryVariableSetResource"
          }
        }
      },
      "additionalProperties": false
    },
    "GetAllMachineRolesResponse": {
      "type": "object",
      "required": [
        "MachineRoles"
      ],
      "properties": {
        "MachineRoles": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "GetAllRunbooksByProjectResponseV2": {
      "type": "object",
      "required": [
        "Runbooks"
      ],
      "properties": {
        "Runbooks": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookResource"
          }
        }
      },
      "additionalProperties": false
    },
    "GetArchivedEventFilesResponse": {
      "type": "object",
      "required": [
        "ArchivedFiles"
      ],
      "properties": {
        "ArchivedFiles": {
          "$ref": "#/definitions/ArchivedEventFileResourceCollection"
        }
      },
      "additionalProperties": false
    },
    "GetCapabilitiesResponseV1": {
      "type": "object",
      "required": [
        "Capabilities"
      ],
      "properties": {
        "Capabilities": {
          "type": "array",
          "description": "list of supported Commands and Requests that this server has",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "GetCloudTemplateMetadataRequest": {
      "type": "object",
      "required": [
        "Id",
        "Template"
      ],
      "properties": {
        "FeedId": {
          "type": "string",
          "description": "Id of the feed from which to load the package. Obsolete."
        },
        "Id": {
          "type": "string",
          "description": "The id of a supported cloud template type, eg `CloudFormation`, `Terraform`, `AzureAppService`, `Kubernetes`, etc"
        },
        "PackageId": {
          "type": "string",
          "description": "Id of the package to load and parse. Obsolete."
        },
        "Template": {
          "type": "string",
          "description": "The cloud template to evaluate and extract parameters and values from",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GetCommonVariablesByTenantIdResponse": {
      "type": "object",
      "required": [
        "ConcurrencyToken",
        "TenantId",
        "Variables"
      ],
      "properties": {
        "ConcurrencyToken": {
          "type": "string",
          "minLength": 1
        },
        "MissingVariables": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/MissingTenantCommonVariable"
          }
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        },
        "Variables": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TenantCommonVariableV2"
          }
        }
      },
      "additionalProperties": false
    },
    "GetContainerLogsResponse": {
      "type": "object",
      "required": [
        "IsSessionCompleted",
        "Logs"
      ],
      "properties": {
        "Error": {
          "$ref": "#/definitions/MonitorErrorResource"
        },
        "IsSessionCompleted": {
          "type": "boolean"
        },
        "Logs": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ContainerLogLineResource"
          }
        }
      },
      "additionalProperties": false
    },
    "GetCurrentLicenseFeaturesResponse": {
      "type": "object",
      "required": [
        "EnabledFeatures"
      ],
      "properties": {
        "EnabledFeatures": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "GetDeploymentFreezeByIdResponse": {
      "type": "object",
      "required": [
        "End",
        "Id",
        "Name",
        "Start"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "End": {
          "type": "string",
          "format": "date-time"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectEnvironmentScope": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          }
        },
        "RecurringSchedule": {
          "$ref": "#/definitions/RecurringScheduleResource"
        },
        "Start": {
          "type": "string",
          "format": "date-time"
        },
        "TenantProjectEnvironmentScope": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "$ref": "#/definitions/TenantProjectEnvironment"
          }
        }
      },
      "additionalProperties": false
    },
    "GetDeploymentFreezesResponse": {
      "type": "object",
      "required": [
        "Count",
        "DeploymentFreezes"
      ],
      "properties": {
        "Count": {
          "type": "integer",
          "format": "int32"
        },
        "DeploymentFreezes": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentFreezeResource"
          }
        }
      },
      "additionalProperties": false
    },
    "GetDeploymentTargetsResponseV2": {
      "type": "object",
      "required": [
        "DeploymentTargets",
        "TargetCountPerHealthStatus"
      ],
      "properties": {
        "DeploymentTargets": {
          "$ref": "#/definitions/MachineResourcePaginatedCollection"
        },
        "TargetCountPerHealthStatus": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "additionalProperties": false
    },
    "GetDeploymentTargetTagByTagResponse": {
      "type": "object",
      "required": [
        "SpaceId",
        "Tag"
      ],
      "properties": {
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Tag": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "GetDeploymentTargetTagsResponse": {
      "type": "object",
      "required": [
        "Count",
        "DeploymentTargetTags"
      ],
      "properties": {
        "Count": {
          "type": "integer",
          "format": "int32"
        },
        "DeploymentTargetTags": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentTargetTagResource"
          }
        }
      },
      "additionalProperties": false
    },
    "GetEnvironmentsResponse": {
      "type": "object",
      "required": [
        "Environments"
      ],
      "properties": {
        "Environments": {
          "$ref": "#/definitions/EnvironmentResourceCollection"
        }
      },
      "additionalProperties": false
    },
    "GetEnvironmentsSummaryResponseV2": {
      "type": "object",
      "required": [
        "DeploymentTargetSummaries",
        "EnvironmentSummaries",
        "MachineEndpointSummaries",
        "MachineHealthStatusSummaries",
        "MachineIdsForCalamariUpgrade",
        "MachineTenantSummaries",
        "MachineTenantTagSummaries",
        "TentacleUpgradesRequired",
        "TotalDisabledMachines",
        "TotalMachines"
      ],
      "properties": {
        "DeploymentTargetSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "EnvironmentSummaries": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/EnvironmentSummaryV2Resource"
          }
        },
        "MachineEndpointSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineHealthStatusSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineIdsForCalamariUpgrade": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "MachineTenantSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineTenantTagSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "TentacleUpgradesRequired": {
          "type": "boolean"
        },
        "TotalDisabledMachines": {
          "type": "integer",
          "format": "int32"
        },
        "TotalMachines": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GetEphemeralEnvironmentProjectStatusResponse": {
      "type": "object",
      "required": [
        "Status"
      ],
      "properties": {
        "Status": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "GetGitCredentialByIdResponse": {
      "type": "object",
      "required": [
        "GitCredential"
      ],
      "properties": {
        "GitCredential": {
          "$ref": "#/definitions/GitCredentialResource"
        }
      },
      "additionalProperties": false
    },
    "GetGitCredentialByIdResponseV2": {
      "type": "object",
      "required": [
        "GitCredential"
      ],
      "properties": {
        "GitCredential": {
          "$ref": "#/definitions/GitCredentialResourceV2"
        }
      },
      "additionalProperties": false
    },
    "GetGitCredentialsResponse": {
      "type": "object",
      "required": [
        "GitCredentials"
      ],
      "properties": {
        "GitCredentials": {
          "$ref": "#/definitions/GitCredentialResourceCollection"
        }
      },
      "additionalProperties": false
    },
    "GetGitCredentialUsageByIdResponse": {
      "type": "object",
      "required": [
        "OtherProjects",
        "Projects"
      ],
      "properties": {
        "OtherProjects": {
          "type": "integer",
          "format": "int32"
        },
        "Projects": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GetGitCredentialUsageByIdResponseProject"
          }
        }
      },
      "additionalProperties": false
    },
    "GetGitCredentialUsageByIdResponseProject": {
      "type": "object",
      "required": [
        "Name",
        "ProjectId",
        "Slug"
      ],
      "properties": {
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "RepositoryUrl": {
          "type": "string"
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GetGitHubAppConnectionByIdResponse": {
      "type": "object",
      "required": [
        "Id",
        "Repositories",
        "SpaceId",
        "Status",
        "UnknownRepositories"
      ],
      "properties": {
        "Id": {
          "type": "string"
        },
        "Installation": {
          "$ref": "#/definitions/GitHubAppInstallation"
        },
        "Repositories": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitHubRepositoryResponse"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Status": {
          "type": "string",
          "minLength": 1
        },
        "StatusUserMessage": {
          "type": "string"
        },
        "UnknownRepositories": {
          "type": "array",
          "description": "Repositories IDs that are configured on the connection but do not have a matching repository returned from GitHub.",
          "items": {
            "$ref": "#/definitions/GitHubUnknownRepositoryResponse"
          }
        }
      },
      "additionalProperties": false
    },
    "GetGitHubAppConnectionsResponse": {
      "type": "object",
      "required": [
        "Connections",
        "ItemsPerPage",
        "NumberOfPages",
        "TotalResults"
      ],
      "properties": {
        "Connections": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitHubAppConnectionResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32"
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GetGitHubAppInstallationsForUserResponse": {
      "type": "object",
      "required": [
        "Installations"
      ],
      "properties": {
        "Installations": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitHubAppInstallation"
          }
        }
      },
      "additionalProperties": false
    },
    "GetGitHubAppSettingsResponse": {
      "type": "object",
      "required": [
        "CanUseGitHubApp",
        "CanUseTrustedFlow"
      ],
      "properties": {
        "CanUseGitHubApp": {
          "type": "boolean"
        },
        "CanUseTrustedFlow": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "GetGitHubAppStatusResponse": {
      "type": "object",
      "required": [
        "Status"
      ],
      "properties": {
        "Status": {
          "type": "string",
          "description": "The status of the GitHub App registration. Valid values are: Connected, RegistrationInvalid, Error.",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GetGitHubRepositoriesForConnectionResponse": {
      "type": "object",
      "required": [
        "Repositories"
      ],
      "properties": {
        "Repositories": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitHubRepositoryResponse"
          }
        }
      },
      "additionalProperties": false
    },
    "GetGitHubUserAuthorizationStatusResponse": {
      "type": "object",
      "required": [
        "CanAuthorize",
        "IsAuthorized"
      ],
      "properties": {
        "CanAuthorize": {
          "type": "boolean"
        },
        "IsAuthorized": {
          "type": "boolean"
        },
        "UserDetails": {
          "$ref": "#/definitions/GetGitHubUserAuthorizationStatusResponseUserDetails"
        }
      },
      "additionalProperties": false
    },
    "GetGitHubUserAuthorizationStatusResponseUserDetails": {
      "type": "object",
      "properties": {
        "AvatarUrl": {
          "type": "string"
        },
        "Login": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "PrimaryEmail": {
          "type": "string"
        },
        "RefreshTokenValidTo": {
          "type": "string",
          "format": "date-time"
        },
        "TokenValidTo": {
          "type": "string",
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "GetIconCategoriesResponse": {
      "type": "object",
      "required": [
        "categories"
      ],
      "properties": {
        "categories": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "additionalProperties": false
    },
    "GetInsightsDeploymentsForProjectResponse": {
      "type": "object",
      "required": [
        "ProjectName",
        "Streams"
      ],
      "properties": {
        "ProjectName": {
          "type": "string",
          "minLength": 1
        },
        "Streams": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/InsightsDeploymentsForXResponseDeploymentStream"
          }
        }
      },
      "additionalProperties": false
    },
    "GetInsightsDeploymentsForReportResponse": {
      "type": "object",
      "required": [
        "ReportName",
        "Streams"
      ],
      "properties": {
        "ReportName": {
          "type": "string",
          "minLength": 1
        },
        "Streams": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/InsightsDeploymentsForXResponseDeploymentStream"
          }
        }
      },
      "additionalProperties": false
    },
    "GetInsightsMetricsSeriesForProjectResponse": {
      "type": "object",
      "required": [
        "Series"
      ],
      "properties": {
        "Series": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/InsightsDataSeriesResource"
          }
        }
      },
      "additionalProperties": false
    },
    "GetInsightsMetricsSeriesForReportResponse": {
      "type": "object",
      "required": [
        "Series"
      ],
      "properties": {
        "Series": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/InsightsDataSeriesResource"
          }
        }
      },
      "additionalProperties": false
    },
    "GetInsightsReportByIdResponse": {
      "type": "object",
      "required": [
        "Report"
      ],
      "properties": {
        "Report": {
          "$ref": "#/definitions/InsightsReportResource"
        }
      },
      "additionalProperties": false
    },
    "GetJsonWebKeysResponse": {
      "type": "object",
      "required": [
        "keys"
      ],
      "properties": {
        "keys": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/JsonWebKey"
          }
        }
      },
      "additionalProperties": false
    },
    "GetKubernetesMonitorByIdResponse": {
      "type": "object",
      "required": [
        "Resource"
      ],
      "properties": {
        "Resource": {
          "$ref": "#/definitions/KubernetesMonitorResource"
        }
      },
      "additionalProperties": false
    },
    "GetLibraryVariableSetUsageResponse": {
      "type": "object",
      "required": [
        "CountOfProjectsUserCannotSee",
        "CountOfReleasesUserCannotSee",
        "CountOfRunbookSnapshotsUserCannotSee",
        "Projects"
      ],
      "properties": {
        "CountOfProjectsUserCannotSee": {
          "type": "integer",
          "format": "int32"
        },
        "CountOfReleasesUserCannotSee": {
          "type": "integer",
          "format": "int32"
        },
        "CountOfRunbookSnapshotsUserCannotSee": {
          "type": "integer",
          "format": "int32"
        },
        "Projects": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/LibraryVariableSetProjectUsage"
          }
        }
      },
      "additionalProperties": false
    },
    "GetLiveStatusResponse": {
      "type": "object",
      "required": [
        "MachineStatuses",
        "Summary"
      ],
      "properties": {
        "MachineStatuses": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/KubernetesMachineLiveStatusResource"
          }
        },
        "Summary": {
          "$ref": "#/definitions/LiveStatusSummaryResource"
        }
      },
      "additionalProperties": false
    },
    "GetMatchingRefsResponseV1": {
      "type": "object",
      "required": [
        "References",
        "TotalCount"
      ],
      "properties": {
        "References": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ValidatedGitReferenceResource"
          }
        },
        "TotalCount": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GetMissingPackagesForReleaseResponse": {
      "type": "object",
      "required": [
        "Packages"
      ],
      "properties": {
        "Packages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/MissingPackageInfo"
          }
        }
      },
      "additionalProperties": false
    },
    "GetOpenIdConfigurationResponse": {
      "type": "object",
      "required": [
        "claims_supported",
        "id_token_signing_alg_values_supported",
        "issuer",
        "jwks_uri",
        "response_types_supported",
        "scopes_supported",
        "subject_types_supported",
        "token_endpoint"
      ],
      "properties": {
        "claims_supported": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "id_token_signing_alg_values_supported": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "issuer": {
          "type": "string",
          "minLength": 1
        },
        "jwks_uri": {
          "type": "string",
          "minLength": 1
        },
        "response_types_supported": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "scopes_supported": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "subject_types_supported": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "token_endpoint": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GetOpenTelemetryTraceFileExportConfigurationResponse": {
      "type": "object",
      "required": [
        "Enabled",
        "MaxStorageSizeMegabytes",
        "RetentionDays"
      ],
      "properties": {
        "Enabled": {
          "type": "boolean"
        },
        "MaxStorageSizeMegabytes": {
          "type": "integer",
          "format": "int32"
        },
        "RetentionDays": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GetParentEnvironmentResponse": {
      "type": "object",
      "required": [
        "AutomaticDeprovisioningRule",
        "Id",
        "Name",
        "Slug",
        "SortOrder",
        "SpaceId",
        "UseGuidedFailure"
      ],
      "properties": {
        "AutomaticDeprovisioningRule": {
          "$ref": "#/definitions/AutomaticDeprovisioningRuleResource"
        },
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "example": "Environments-1"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "SortOrder": {
          "type": "integer",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "UseGuidedFailure": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "GetPlatformHubGitHubAppConnectionByIdResponse": {
      "type": "object",
      "required": [
        "Id",
        "Repositories",
        "Status",
        "UnknownRepositories"
      ],
      "properties": {
        "Id": {
          "type": "string"
        },
        "Installation": {
          "$ref": "#/definitions/GitHubAppInstallation"
        },
        "Repositories": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitHubRepositoryResponse"
          }
        },
        "Status": {
          "type": "string",
          "minLength": 1
        },
        "StatusUserMessage": {
          "type": "string"
        },
        "UnknownRepositories": {
          "type": "array",
          "description": "Repositories IDs that are configured on the connection but do not have a matching repository returned from GitHub.",
          "items": {
            "$ref": "#/definitions/GitHubUnknownRepositoryResponse"
          }
        }
      },
      "additionalProperties": false
    },
    "GetPlatformHubGitHubAppConnectionsResponse": {
      "type": "object",
      "required": [
        "Connections",
        "ItemsPerPage",
        "NumberOfPages",
        "TotalResults"
      ],
      "properties": {
        "Connections": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitHubAppConnectionResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32"
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GetPlatformHubGitHubAppInstallationsForUserResponse": {
      "type": "object",
      "required": [
        "Installations"
      ],
      "properties": {
        "Installations": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitHubAppInstallation"
          }
        }
      },
      "additionalProperties": false
    },
    "GetProcessTemplateByVersionMaskResponse": {
      "type": "object",
      "required": [
        "ProcessTemplate",
        "ProcessTemplateVersion"
      ],
      "properties": {
        "ProcessTemplate": {
          "$ref": "#/definitions/ProcessTemplateResource"
        },
        "ProcessTemplateVersion": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GetProcessTemplateSharingConfigurationResponse": {
      "type": "object",
      "required": [
        "IndividuallySharedSpaceIds",
        "SharedToAllSpaces"
      ],
      "properties": {
        "IndividuallySharedSpaceIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Spaces-1",
            "..."
          ]
        },
        "SharedToAllSpaces": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "GetProcessTemplatesResponse": {
      "type": "object",
      "required": [
        "ItemsPerPage",
        "ProcessTemplates",
        "TotalResults"
      ],
      "properties": {
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ProcessTemplates": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ProcessTemplateResource"
          }
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GetProjectBadgeJsonResponse": {
      "type": "object",
      "required": [
        "Color",
        "EnvironmentName",
        "Label",
        "Message",
        "ProjectName"
      ],
      "properties": {
        "Color": {
          "type": "string",
          "minLength": 1
        },
        "EnvironmentName": {
          "type": "string",
          "minLength": 1
        },
        "Label": {
          "type": "string",
          "minLength": 1
        },
        "Message": {
          "type": "string",
          "minLength": 1
        },
        "ProjectName": {
          "type": "string",
          "minLength": 1
        },
        "TenantName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "GetProjectProgressionResponse": {
      "type": "object",
      "required": [
        "Progression"
      ],
      "properties": {
        "Progression": {
          "$ref": "#/definitions/ProgressionResource"
        }
      },
      "additionalProperties": false
    },
    "GetProjectSummaryInDatabaseResponse": {
      "type": "object",
      "required": [
        "HasBeenSuccessfullyDeployed",
        "HasDeploymentProcess",
        "HasRunbooks"
      ],
      "properties": {
        "HasBeenSuccessfullyDeployed": {
          "type": "boolean"
        },
        "HasDeploymentProcess": {
          "type": "boolean"
        },
        "HasRunbooks": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "GetProjectSummaryInGitResponse": {
      "type": "object",
      "required": [
        "HasBeenSuccessfullyDeployed",
        "HasDeploymentProcess",
        "HasRunbooks"
      ],
      "properties": {
        "HasBeenSuccessfullyDeployed": {
          "type": "boolean"
        },
        "HasDeploymentProcess": {
          "type": "boolean"
        },
        "HasRunbooks": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "GetProjectVariablesByTenantIdResponse": {
      "type": "object",
      "required": [
        "ConcurrencyToken",
        "TenantId",
        "Variables"
      ],
      "properties": {
        "ConcurrencyToken": {
          "type": "string",
          "minLength": 1
        },
        "MissingVariables": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/MissingTenantProjectVariable"
          }
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        },
        "Variables": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TenantProjectVariableV2"
          }
        }
      },
      "additionalProperties": false
    },
    "GetPublishedProcessTemplateByVersionMaskResponse": {
      "type": "object",
      "required": [
        "ProcessTemplate",
        "ProcessTemplateVersion"
      ],
      "properties": {
        "ProcessTemplate": {
          "$ref": "#/definitions/ProcessTemplateResource"
        },
        "ProcessTemplateVersion": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GetReleaseDeploymentPreviewsRequest": {
      "type": "object",
      "required": [
        "DeploymentPreviews",
        "ReleaseId",
        "SpaceId"
      ],
      "properties": {
        "DeploymentPreviews": {
          "type": "array",
          "description": "The array of requests you would like to make",
          "items": {
            "$ref": "#/definitions/DeploymentPreviewRequest"
          }
        },
        "IncludeDisabledSteps": {
          "type": "boolean",
          "description": "Whether to include Disabled Steps in the preview"
        },
        "ReleaseId": {
          "type": "string",
          "description": "ID of the release",
          "example": "Releases-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "ID of the space containing the resources",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "GetResourceEventsResponse": {
      "type": "object",
      "required": [
        "Events",
        "IsSessionCompleted"
      ],
      "properties": {
        "Error": {
          "$ref": "#/definitions/MonitorErrorResource"
        },
        "Events": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/KubernetesEventResource"
          }
        },
        "IsSessionCompleted": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "GetResourceManifestResponse": {
      "type": "object",
      "required": [
        "LiveManifest"
      ],
      "properties": {
        "DesiredManifest": {
          "type": "string"
        },
        "Diff": {
          "$ref": "#/definitions/LiveResourceDiff"
        },
        "LiveManifest": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GetResourceManifestResponseV2": {
      "type": "object",
      "properties": {
        "DesiredManifest": {
          "type": "string"
        },
        "Diff": {
          "$ref": "#/definitions/LiveResourceDiffV2"
        },
        "LiveManifest": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "GetResourceResponse": {
      "type": "object",
      "required": [
        "Resource"
      ],
      "properties": {
        "Resource": {
          "$ref": "#/definitions/KubernetesLiveStatusDetailedResource"
        }
      },
      "additionalProperties": false
    },
    "GetRunbookEnvironmentsInDatabaseResponseV2": {
      "type": "object",
      "required": [
        "Environments"
      ],
      "properties": {
        "Environments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/BaseEnvironmentV2Resource"
          }
        }
      },
      "additionalProperties": false
    },
    "GetRunbookEnvironmentsInGitResponseV2": {
      "type": "object",
      "required": [
        "Environments"
      ],
      "properties": {
        "Environments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/BaseEnvironmentV2Resource"
          }
        }
      },
      "additionalProperties": false
    },
    "GetRunbookProgressionResponse": {
      "type": "object",
      "required": [
        "Progression"
      ],
      "properties": {
        "Progression": {
          "$ref": "#/definitions/RunbooksProgressionResource"
        }
      },
      "additionalProperties": false
    },
    "GetRunbookRunDetailsResponse": {
      "type": "object",
      "required": [
        "GitResources",
        "Packages"
      ],
      "properties": {
        "GitResources": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseTemplateGitResource"
          }
        },
        "Packages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseTemplatePackage"
          }
        }
      },
      "additionalProperties": false
    },
    "GetRunbookRunPreviewsForRunbookSnapshotRequest": {
      "type": "object",
      "required": [
        "DeploymentPreviews",
        "ProjectId",
        "RunbookSnapshotId",
        "SpaceId"
      ],
      "properties": {
        "DeploymentPreviews": {
          "type": "array",
          "description": "The environment/tenant combinations to preview, one entry per combination. Leave an entry's TenantId unset to preview an untenanted run in that environment.",
          "items": {
            "$ref": "#/definitions/DeploymentPreviewRequest"
          }
        },
        "IncludeDisabledSteps": {
          "type": "boolean",
          "description": "Boolean to include/exclude disabled steps from response"
        },
        "ProjectId": {
          "type": "string",
          "description": "ID of the Project",
          "example": "Projects-1"
        },
        "RunbookSnapshotId": {
          "type": "string",
          "description": "ID of the Runbook Snapshot"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "GetRunbookRunPreviewsInDatabaseRequest": {
      "type": "object",
      "description": "Gets a list of Runbook Run Previews that describes what steps will/won't be run during a Runbook Run on a given environment and tenant for a Runbook.",
      "required": [
        "DeploymentPreviews",
        "ProjectId",
        "RunbookId",
        "SpaceId"
      ],
      "properties": {
        "DeploymentPreviews": {
          "type": "array",
          "description": "A list of Tenant/Environment mappings to retrieve runbook run previews for",
          "items": {
            "$ref": "#/definitions/DeploymentPreviewRequest"
          }
        },
        "IncludeDisabledSteps": {
          "type": "boolean",
          "description": "Boolean to include/exclude disabled steps from response"
        },
        "ProjectId": {
          "type": "string",
          "description": "ID of the Project",
          "example": "Projects-1"
        },
        "RunbookId": {
          "type": "string",
          "description": "ID of the Runbook",
          "example": "Runbooks-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "GetRunbookRunPreviewsInGitRequest": {
      "type": "object",
      "description": "Gets a list of Runbook Run Previews that describes what steps will/won't be run during a Runbook Run on a given environment and tenant for a Runbook.",
      "required": [
        "DeploymentPreviews",
        "GitRef",
        "ProjectId",
        "RunbookId",
        "SpaceId"
      ],
      "properties": {
        "DeploymentPreviews": {
          "type": "array",
          "description": "A list of Tenant/Environment mappings to retrieve runbook run previews for",
          "items": {
            "$ref": "#/definitions/DeploymentPreviewRequest"
          }
        },
        "GitRef": {
          "type": "string"
        },
        "IncludeDisabledSteps": {
          "type": "boolean",
          "description": "Boolean to include/exclude disabled steps from response"
        },
        "ProjectId": {
          "type": "string",
          "description": "ID of the Project",
          "example": "Projects-1"
        },
        "RunbookId": {
          "type": "string",
          "description": "ID of the Runbook",
          "example": "Runbooks-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "GetServerTaskApprovalByTaskIdResponse": {
      "type": "object",
      "properties": {
        "Resource": {
          "$ref": "#/definitions/GetServerTaskApprovalByTaskIdResponseResource"
        }
      },
      "additionalProperties": false
    },
    "GetServerTaskApprovalByTaskIdResponseResource": {
      "type": "object",
      "required": [
        "Approvals",
        "ApprovalsCount",
        "ApprovalState",
        "Id",
        "MinimumApproversRequired",
        "SpaceId"
      ],
      "properties": {
        "Approvals": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ApprovalResource"
          }
        },
        "ApprovalsCount": {
          "type": "integer",
          "format": "int32"
        },
        "ApprovalState": {
          "type": "string",
          "minLength": 1
        },
        "ApprovingTeams": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/NamedReferenceItem"
          }
        },
        "ApprovingUsers": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/NamedReferenceItem"
          }
        },
        "Id": {
          "type": "string"
        },
        "MinimumApproversRequired": {
          "type": "integer",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "GetServerTaskStatusMessagesResponse": {
      "type": "object",
      "required": [
        "Messages"
      ],
      "properties": {
        "Messages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ServerTaskStatusMessageResource"
          }
        }
      },
      "additionalProperties": false
    },
    "GetServiceAccountOidcIdentitiesResponseV1": {
      "type": "object",
      "required": [
        "Count",
        "ExternalId",
        "OidcIdentities",
        "ServerUrl"
      ],
      "properties": {
        "Count": {
          "type": "integer",
          "format": "int32"
        },
        "ExternalId": {
          "type": "string",
          "minLength": 1
        },
        "OidcIdentities": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ServiceAccountOidcIdentityResource"
          }
        },
        "ServerUrl": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GetServiceAccountOidcIdentityByIdResponseV1": {
      "type": "object",
      "required": [
        "Id",
        "Issuer",
        "Name",
        "ServiceAccountId",
        "Subject"
      ],
      "properties": {
        "Audience": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "Issuer": {
          "type": "string",
          "minLength": 1
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ServiceAccountId": {
          "type": "string",
          "example": "Users-1"
        },
        "Subject": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GetSmtpConfigurationResponse": {
      "type": "object",
      "required": [
        "SmtpConfiguration"
      ],
      "properties": {
        "SmtpConfiguration": {
          "$ref": "#/definitions/SmtpConfigurationResource"
        }
      },
      "additionalProperties": false
    },
    "GetSmtpIsConfiguredResponse": {
      "type": "object",
      "required": [
        "SmtpIsConfigured"
      ],
      "properties": {
        "SmtpIsConfigured": {
          "$ref": "#/definitions/SmtpIsConfiguredResource"
        }
      },
      "additionalProperties": false
    },
    "GetSshKnownHostsResponse": {
      "type": "object",
      "required": [
        "Resources",
        "TotalCount"
      ],
      "properties": {
        "FilteredCount": {
          "type": "integer",
          "format": "int32"
        },
        "Resources": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SshKnownHostResource"
          }
        },
        "TotalCount": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GetTasksForDeploymentTargetResponse": {
      "type": "object",
      "required": [
        "ResourceCollection"
      ],
      "properties": {
        "ResourceCollection": {
          "$ref": "#/definitions/TaskResourceCollection"
        }
      },
      "additionalProperties": false
    },
    "GetTeamMembershipPreviewRequest": {
      "type": "object",
      "description": "Lists all the Users that would belong to the specified Team, including information about whether they are directly assigned and/or indirectly assigned via external security groups.",
      "required": [
        "ExternalSecurityGroups",
        "MemberUserIds",
        "Name"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "ExternalSecurityGroups": {
          "type": "array",
          "description": "The externally-managed security groups (e.g., Active Directory groups) who belong to the team.",
          "items": {
            "$ref": "#/definitions/NamedReferenceItem"
          }
        },
        "Id": {
          "type": "string",
          "example": "Teams-1"
        },
        "MemberUserIds": {
          "type": "array",
          "description": "The users who belong to the team.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Users-1",
            "..."
          ]
        },
        "Name": {
          "type": "string",
          "description": "Gets or sets the name of this team.",
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "GetUserApiKeysResponse": {
      "type": "object",
      "properties": {
        "ApiKeys": {
          "$ref": "#/definitions/ApiKeyResourceCollection"
        }
      },
      "additionalProperties": false
    },
    "GetUserAuthenticationProvidersResponse": {
      "type": "object",
      "required": [
        "AuthenticationProviders",
        "CanCurrentUserEditIdentitiesForUser",
        "Links"
      ],
      "properties": {
        "AuthenticationProviders": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/AuthenticationProviderElement"
          }
        },
        "CanCurrentUserEditIdentitiesForUser": {
          "type": "boolean"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "GetUserIdentityMetadataResponse": {
      "type": "object",
      "required": [
        "Links",
        "Providers"
      ],
      "properties": {
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Providers": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/IdentityMetadataResource"
          }
        }
      },
      "additionalProperties": false
    },
    "GetVariablesScopedToSingleDeploymentTargetResponse": {
      "type": "object",
      "required": [
        "Resource"
      ],
      "properties": {
        "Resource": {
          "$ref": "#/definitions/VariablesScopedToDocumentResource"
        }
      },
      "additionalProperties": false
    },
    "GetWorkersResponseV2": {
      "type": "object",
      "required": [
        "WorkerCountPerHealthStatus",
        "Workers"
      ],
      "properties": {
        "WorkerCountPerHealthStatus": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "Workers": {
          "$ref": "#/definitions/WorkerResourcePaginatedCollection"
        }
      },
      "additionalProperties": false
    },
    "GetWorkerTaskLeasesResponse": {
      "type": "object",
      "required": [
        "WorkerTaskLeases"
      ],
      "properties": {
        "WorkerTaskLeases": {
          "$ref": "#/definitions/WorkerTaskLeaseResourceCollection"
        }
      },
      "additionalProperties": false
    },
    "GitBranchResource": {
      "type": "object",
      "required": [
        "CanonicalName",
        "IsProtected",
        "Name"
      ],
      "properties": {
        "CanonicalName": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsProtected": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GitBranchResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitBranchResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GitBranchResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitBranchResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GitCommitResource": {
      "type": "object",
      "required": [
        "CanonicalName",
        "Name"
      ],
      "properties": {
        "CanonicalName": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GitCredentialDetailsResource": {
      "type": "object",
      "properties": {
        "Type": {
          "type": "string",
          "enum": [
            "UsernamePassword",
            "Anonymous",
            "Library",
            "GitHub",
            "NotSpecified",
            "SshKey"
          ],
          "readOnly": true
        }
      },
      "additionalProperties": false
    },
    "GitCredentialDetailsResourceV2": {
      "type": "object",
      "properties": {
        "Type": {
          "type": "string",
          "enum": [
            "UsernamePassword",
            "Anonymous",
            "Library",
            "GitHub",
            "NotSpecified",
            "SshKey"
          ],
          "readOnly": true
        }
      },
      "additionalProperties": false
    },
    "GitCredentialRepositoryRestrictionsResource": {
      "type": "object",
      "properties": {
        "AllowedRepositories": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Enabled": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "GitCredentialRepositoryRestrictionsResourceV2": {
      "type": "object",
      "properties": {
        "AllowedRepositories": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Enabled": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "GitCredentialResource": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/GitCredentialDetailsResource"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "RepositoryRestrictions": {
          "$ref": "#/definitions/GitCredentialRepositoryRestrictionsResource"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "GitCredentialResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitCredentialResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GitCredentialResourceV2": {
      "type": "object",
      "required": [
        "Details",
        "Id",
        "Name",
        "RepositoryRestrictions",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/GitCredentialDetailsResourceV2"
        },
        "Id": {
          "type": "string"
        },
        "LastModifiedBy": {
          "type": "string"
        },
        "LastModifiedOn": {
          "type": "string",
          "format": "date-time"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "RepositoryRestrictions": {
          "$ref": "#/definitions/GitCredentialRepositoryRestrictionsResourceV2"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "GitCredentialResourceV2PaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitCredentialResourceV2"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GitCredentialUsageResource": {
      "type": "object",
      "properties": {
        "Type": {
          "type": "string",
          "enum": [
            "Anonymous",
            "UsernamePassword",
            "Reference",
            "GitHub",
            "SshKey"
          ],
          "readOnly": true
        }
      },
      "additionalProperties": false
    },
    "GitDependencyResource": {
      "type": "object",
      "required": [
        "DefaultBranch",
        "GitCredentialType",
        "Name",
        "RepositoryUri"
      ],
      "properties": {
        "DefaultBranch": {
          "type": "string",
          "minLength": 1
        },
        "FilePathFilters": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "GitCredentialId": {
          "type": "string"
        },
        "GitCredentialType": {
          "type": "string",
          "minLength": 1
        },
        "GitHubConnectionId": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "RepositoryUri": {
          "type": "string",
          "minLength": 1
        },
        "StepPackageInputsReferenceId": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "GitHubAppConnectionResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string"
        },
        "Installation": {
          "$ref": "#/definitions/GitHubAppInstallationResource"
        },
        "Status": {
          "type": "string",
          "enum": [
            "ConnectionNotFound",
            "InstallationNotFound",
            "InstallationSuspended",
            "Connected",
            "Error"
          ]
        }
      },
      "additionalProperties": false
    },
    "GitHubAppInstallation": {
      "type": "object",
      "properties": {
        "AccountAvatarUrl": {
          "type": "string"
        },
        "AccountId": {
          "type": "string"
        },
        "AccountLogin": {
          "type": "string"
        },
        "AccountType": {
          "type": "string"
        },
        "AllRepositories": {
          "type": "boolean",
          "description": "true if the installation has access to all repositories in the account, false if it has access to only selected repositories."
        },
        "InstallationId": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "GitHubAppInstallationResource": {
      "type": "object",
      "properties": {
        "AccountAvatarUrl": {
          "type": "string"
        },
        "AccountId": {
          "type": "string"
        },
        "AccountLogin": {
          "type": "string"
        },
        "AccountType": {
          "type": "string"
        },
        "AllRepositories": {
          "type": "boolean"
        },
        "InstallationId": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "GitHubConnectivityCheckRequest": {
      "type": "object",
      "required": [
        "BaseUrl"
      ],
      "properties": {
        "BaseUrl": {
          "type": "string",
          "description": "The GitHub base URL to test connectivity to",
          "minLength": 1
        },
        "Password": {
          "type": "string",
          "description": "The GitHub personal access token or password for authentication. If not provided, will be retrieved from configuration."
        },
        "UserName": {
          "type": "string",
          "description": "The GitHub username for authentication."
        }
      },
      "additionalProperties": false
    },
    "GitHubConnectivityCheckResponse": {
      "type": "object",
      "required": [
        "Messages"
      ],
      "properties": {
        "Messages": {
          "type": "array",
          "description": "Messages from the connectivity check",
          "items": {
            "$ref": "#/definitions/ConnectivityCheckMessage"
          }
        }
      },
      "additionalProperties": false
    },
    "GitHubRepositoryResponse": {
      "type": "object",
      "properties": {
        "DefaultBranch": {
          "type": "string"
        },
        "GitUrl": {
          "type": "string"
        },
        "IsAdmin": {
          "type": "boolean"
        },
        "IsPrivate": {
          "type": "boolean"
        },
        "Language": {
          "type": "string"
        },
        "RepositoryId": {
          "type": "string"
        },
        "RepositoryName": {
          "type": "string"
        },
        "Visibility": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "GitHubRepositoryResponsePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitHubRepositoryResponse"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GitHubUnknownRepositoryResponse": {
      "type": "object",
      "properties": {
        "RepositoryId": {
          "type": "string"
        },
        "RepositoryName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "GitNamedRefByNameResource": {
      "type": "object",
      "required": [
        "CanonicalName",
        "IsProtected",
        "Name"
      ],
      "properties": {
        "CanonicalName": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsProtected": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GitPersistenceSettingsConversionStateResource": {
      "type": "object",
      "properties": {
        "RunbooksAreInGit": {
          "type": "boolean"
        },
        "VariablesAreInGit": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "GitPersistenceSettingsResource": {
      "type": "object",
      "required": [
        "BasePath",
        "Credentials",
        "DefaultBranch",
        "Type",
        "Url"
      ],
      "properties": {
        "BasePath": {
          "type": "string"
        },
        "ConversionState": {
          "$ref": "#/definitions/GitPersistenceSettingsConversionStateResource"
        },
        "Credentials": {
          "$ref": "#/definitions/GitCredentialUsageResource"
        },
        "DefaultBranch": {
          "type": "string"
        },
        "ProtectedBranchNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ProtectedDefaultBranch": {
          "type": "boolean"
        },
        "SerializationFormat": {
          "type": "string",
          "enum": [
            "Ocl",
            "Yaml"
          ]
        },
        "Type": {
          "type": "string",
          "default": "VersionControlled",
          "enum": [
            "Database",
            "VersionControlled"
          ]
        },
        "Url": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GitReferenceResource": {
      "type": "object",
      "properties": {
        "GitCommit": {
          "type": "string"
        },
        "GitRef": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "GitReferenceSatisfiesChannelGitReferenceRulesResponseV1": {
      "type": "object",
      "required": [
        "Errors",
        "SatisfiesGitReferenceRules"
      ],
      "properties": {
        "Errors": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SatisfiesGitReferenceRules": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "GitReferenceSatisfiesChannelGitResourceRulesResponseV1": {
      "type": "object",
      "required": [
        "Errors",
        "SatisfiesGitResourceRules"
      ],
      "properties": {
        "Errors": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SatisfiesGitResourceRules": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "GitSettingsTestMessage": {
      "type": "object",
      "required": [
        "Category",
        "Message"
      ],
      "properties": {
        "Category": {
          "type": "string",
          "enum": [
            "Info",
            "Error"
          ]
        },
        "Message": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GitTagResource": {
      "type": "object",
      "required": [
        "CanonicalName",
        "Name"
      ],
      "properties": {
        "CanonicalName": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "GitTagResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitTagResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GitTagResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitTagResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "GlobalDocumentCounts": {
      "type": "object",
      "properties": {
        "Spaces": {
          "type": "integer",
          "format": "int32"
        },
        "Teams": {
          "type": "integer",
          "format": "int32"
        },
        "Users": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "IAuditStreamConfigurationResource": {
      "type": "object",
      "additionalProperties": false
    },
    "IconDetail": {
      "type": "object",
      "properties": {
        "iconHeight": {
          "type": "integer",
          "format": "int32"
        },
        "iconPath": {
          "type": "string"
        },
        "iconWidth": {
          "type": "integer",
          "format": "int32"
        },
        "id": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "searchTerms": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "IconResource": {
      "type": "object",
      "properties": {
        "Color": {
          "type": "string",
          "description": "Icon background colour, as a Hex string"
        },
        "Id": {
          "type": "string",
          "description": "Font Awesome Icon Id"
        }
      },
      "additionalProperties": false
    },
    "IdentityClaimResource": {
      "type": "object",
      "properties": {
        "IsIdentifyingClaim": {
          "type": "boolean"
        },
        "Value": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "IdentityMetadataResource": {
      "type": "object",
      "properties": {
        "ClaimDescriptors": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ClaimDescriptor"
          }
        },
        "IdentityProviderName": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ScimEnabled": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "IdentityResource": {
      "type": "object",
      "properties": {
        "Claims": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/IdentityClaimResource"
          },
          "readOnly": true
        },
        "IdentityProviderName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "InfrastructureDocumentCounts": {
      "type": "object",
      "properties": {
        "DeploymentTargets": {
          "type": "integer",
          "format": "int32"
        },
        "Environments": {
          "type": "integer",
          "format": "int32"
        },
        "Tenants": {
          "type": "integer",
          "format": "int32"
        },
        "WorkerPools": {
          "type": "integer",
          "format": "int32"
        },
        "Workers": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "InsightsDataSeriesResource": {
      "type": "object",
      "required": [
        "Intervals",
        "Name"
      ],
      "properties": {
        "Intervals": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Interval"
          }
        },
        "Name": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "InsightsDeploymentsForXResponseDeployment": {
      "type": "object",
      "required": [
        "CompletedTime",
        "HadGuidedFailure",
        "Id",
        "QueueTime",
        "ReleaseVersion",
        "StartTime",
        "TaskState"
      ],
      "properties": {
        "CompletedTime": {
          "type": "string"
        },
        "DeploymentsUntilRecovery": {
          "type": "integer",
          "format": "int32"
        },
        "HadGuidedFailure": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "example": "Deployments-1"
        },
        "LeadTime": {
          "type": "string"
        },
        "LeadTimeCalculatedFromVersion": {
          "type": "string"
        },
        "PreviousSuccessfulDeploymentId": {
          "type": "string",
          "example": "Deployments-1"
        },
        "QueueTime": {
          "type": "string"
        },
        "RecoveredFromFailedDeploymentId": {
          "type": "string",
          "example": "Deployments-1"
        },
        "RecoveredFromFailedReleaseVersion": {
          "type": "string"
        },
        "ReleaseVersion": {
          "type": "string",
          "minLength": 1
        },
        "StartTime": {
          "type": "string"
        },
        "TaskState": {
          "type": "string",
          "enum": [
            "Queued",
            "Executing",
            "Failed",
            "Canceled",
            "TimedOut",
            "Success",
            "Cancelling"
          ]
        },
        "TimeSincePreviouslySuccessfulDeployment": {
          "type": "string"
        },
        "TimeToRecovery": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "InsightsDeploymentsForXResponseDeploymentStream": {
      "type": "object",
      "required": [
        "ChannelId",
        "ChannelName",
        "Deployments",
        "EnvironmentId",
        "EnvironmentName",
        "ProjectId",
        "ProjectName"
      ],
      "properties": {
        "ChannelId": {
          "type": "string",
          "example": "Channels-1"
        },
        "ChannelName": {
          "type": "string"
        },
        "Deployments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/InsightsDeploymentsForXResponseDeployment"
          }
        },
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "EnvironmentName": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ProjectName": {
          "type": "string"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        },
        "TenantName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "InsightsEnvironmentGroupResource": {
      "type": "object",
      "required": [
        "Environments",
        "Name"
      ],
      "properties": {
        "Environments": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Name": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "InsightsFailureRateMetricResource": {
      "type": "object",
      "properties": {
        "DeploymentFailure": {
          "type": "integer",
          "format": "int32"
        },
        "Failed": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Rate": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "Successful": {
          "type": "integer",
          "format": "int32"
        },
        "SuccessfulButHadGuidedFailure": {
          "type": "integer",
          "format": "int32"
        },
        "SuccessfulButPreventedProgression": {
          "type": "integer",
          "format": "int32"
        },
        "Total": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        }
      },
      "additionalProperties": false
    },
    "InsightsReportResource": {
      "type": "object",
      "required": [
        "AllTenants",
        "ChannelIds",
        "EnvironmentGroups",
        "Name",
        "ProjectGroupIds",
        "ProjectIds",
        "SpaceId",
        "TenantIds",
        "TenantMode",
        "TenantTags",
        "TimeZone"
      ],
      "properties": {
        "AllTenants": {
          "type": "boolean"
        },
        "ChannelIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Channels-1",
            "..."
          ]
        },
        "Description": {
          "type": "string"
        },
        "EnvironmentGroups": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/InsightsEnvironmentGroupResource"
          }
        },
        "IconColor": {
          "type": "string"
        },
        "IconId": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource.",
          "example": "InsightsReports-1"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectGroupIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "ProjectGroups-1",
            "..."
          ]
        },
        "ProjectIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Projects-1",
            "..."
          ]
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantMode": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedAndUntenanted",
            "Tenanted"
          ]
        },
        "TenantTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "TimeZone": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "InsightsReportResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/InsightsReportResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "InterruptionPullRequestResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "example": "InterruptionPullRequests-1"
        },
        "InterruptionId": {
          "type": "string"
        },
        "Number": {
          "type": "integer",
          "format": "int64"
        },
        "RepositoryUrl": {
          "type": "string"
        },
        "Status": {
          "type": "string",
          "enum": [
            "Unknown",
            "Open",
            "Merged",
            "Closed",
            "UnknownGitVendor"
          ]
        },
        "Title": {
          "type": "string"
        },
        "Url": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "InterruptionResource": {
      "type": "object",
      "properties": {
        "CanTakeResponsibility": {
          "type": "boolean",
          "description": "Gets or sets a value indicating whether the current user has permissions to take responsibility for this interruption."
        },
        "CorrelationId": {
          "type": "string",
          "description": "Gets or sets the correlation ID of the activity in which the interruption was requested, if any."
        },
        "Created": {
          "type": "string",
          "description": "Gets the time at which the interruption was created.",
          "format": "date-time"
        },
        "Form": {
          "$ref": "#/definitions/Form"
        },
        "HasResponsibility": {
          "type": "boolean",
          "description": "Gets or sets a value indicating whether the current user has responsibility for this interruption."
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsLinkedToOtherInterruption": {
          "type": "boolean",
          "description": "If this interruption is linked to another it will be automatically completed when the other one is. Used to handle interruptions in child deployments."
        },
        "IsPending": {
          "type": "boolean",
          "description": "True if the interruption is waiting for user action; otherwise, false."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "PullRequests": {
          "type": "array",
          "description": "Gets or sets a list of pull requests associated with this interruption. This will only be populated when Type is PullRequestCompletion.",
          "items": {
            "$ref": "#/definitions/InterruptionPullRequestResource"
          }
        },
        "RelatedDocumentIds": {
          "type": "array",
          "description": "Gets the ids of documents related to this interruption.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ResponsibleTeamIds": {
          "type": "array",
          "description": "Gets the ids of groups that can take responsibility for this interruption.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ResponsibleUserId": {
          "type": "string",
          "description": "Gets or sets the"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TaskId": {
          "type": "string",
          "description": "Gets or sets the id of the Server Task raising the interruption."
        },
        "Title": {
          "type": "string",
          "description": "Gets or sets a title for this interruption."
        },
        "Type": {
          "type": "string",
          "description": "Gets or sets the type of interruption",
          "enum": [
            "ManualIntervention",
            "GuidedFailure",
            "PullRequestCompletion",
            "ArgoCDApplicationSync",
            "KubernetesResourceVerification"
          ]
        }
      },
      "additionalProperties": false
    },
    "InterruptionResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/InterruptionResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "Interval": {
      "type": "object",
      "properties": {
        "DeploymentFailureRate": {
          "$ref": "#/definitions/InsightsFailureRateMetricResource"
        },
        "DeploymentQueuedDuration": {
          "$ref": "#/definitions/DurationMetric"
        },
        "DeploymentsUntilRecovery": {
          "$ref": "#/definitions/DoubleMetric"
        },
        "LeadTime": {
          "$ref": "#/definitions/DurationMetric"
        },
        "MeanTimeToRecovery": {
          "$ref": "#/definitions/DurationMetric"
        },
        "NumberOfSuccessfulDeployments": {
          "type": "integer",
          "format": "int32"
        },
        "StartOfInterval": {
          "type": "string"
        },
        "SuccessfulDeploymentDuration": {
          "$ref": "#/definitions/DurationMetric"
        },
        "TimeSincePreviousDeployment": {
          "$ref": "#/definitions/DurationMetric"
        }
      },
      "additionalProperties": false
    },
    "InvitationResource": {
      "type": "object",
      "required": [
        "AddToTeamIds",
        "Expires",
        "InvitationCode"
      ],
      "properties": {
        "AddToTeamIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Expires": {
          "type": "string",
          "format": "date-time"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource.",
          "example": "Invitations-1"
        },
        "InvitationCode": {
          "type": "string",
          "minLength": 1
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ITenantVariableScope": {
      "type": "object",
      "properties": {
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "readOnly": true,
          "example": [
            "Environments-1",
            "..."
          ]
        }
      },
      "additionalProperties": false
    },
    "JiraServiceManagementConnectionCheckRequest": {
      "type": "object",
      "properties": {
        "BaseUrl": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "Token": {
          "type": "string"
        },
        "Username": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "JsonWebKey": {
      "type": "object",
      "required": [
        "e",
        "kid",
        "kty",
        "n",
        "use"
      ],
      "properties": {
        "e": {
          "type": "string",
          "minLength": 1
        },
        "kid": {
          "type": "string",
          "minLength": 1
        },
        "kty": {
          "type": "string",
          "minLength": 1
        },
        "n": {
          "type": "string",
          "minLength": 1
        },
        "use": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "KubernetesEventResource": {
      "type": "object",
      "properties": {
        "Action": {
          "type": "string"
        },
        "Count": {
          "type": "integer",
          "format": "int32"
        },
        "FirstObservedTime": {
          "type": "string"
        },
        "LastObservedTime": {
          "type": "string"
        },
        "Manifest": {
          "type": "string"
        },
        "Note": {
          "type": "string"
        },
        "Reason": {
          "type": "string"
        },
        "ReportingController": {
          "type": "string"
        },
        "ReportingInstance": {
          "type": "string"
        },
        "Type": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "KubernetesLiveStatusDetailedResource": {
      "type": "object",
      "required": [
        "Children",
        "HealthStatus",
        "Kind",
        "LastUpdated",
        "Name",
        "ResourceSourceId",
        "SourceType"
      ],
      "properties": {
        "Children": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/KubernetesLiveStatusDetailedResource"
          }
        },
        "DesiredResourceId": {
          "type": "string",
          "format": "uuid"
        },
        "ExternalLink": {
          "$ref": "#/definitions/ExternalLinkResource"
        },
        "HealthStatus": {
          "type": "string",
          "enum": [
            "Stale"
          ]
        },
        "HealthStatusMessage": {
          "type": "string"
        },
        "Kind": {
          "type": "string",
          "minLength": 1
        },
        "LastUpdated": {
          "type": "string"
        },
        "ManifestSummary": {
          "$ref": "#/definitions/ManifestSummaryResource"
        },
        "Name": {
          "type": "string"
        },
        "Namespace": {
          "type": "string"
        },
        "ResourceId": {
          "type": "string",
          "format": "uuid"
        },
        "ResourceSourceId": {
          "type": "string"
        },
        "SourceType": {
          "type": "string",
          "enum": [
            "KubernetesMonitor",
            "ArgoCDInstance",
            "ArgoCDApplication"
          ]
        },
        "SyncStatus": {
          "type": "string"
        },
        "SyncStatusMessage": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "KubernetesLiveStatusResource": {
      "type": "object",
      "required": [
        "Children",
        "Group",
        "HealthStatus",
        "Kind",
        "LastUpdated",
        "MachineId",
        "Name",
        "ResourceSourceId",
        "SourceType"
      ],
      "properties": {
        "Children": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/KubernetesLiveStatusResource"
          }
        },
        "DeletionTaskErrorMessage": {
          "type": "string"
        },
        "DeletionTaskId": {
          "type": "string",
          "example": "ServerTasks-1"
        },
        "DeletionTaskState": {
          "type": "string"
        },
        "DesiredResourceId": {
          "type": "string",
          "format": "uuid"
        },
        "Group": {
          "type": "string",
          "minLength": 1
        },
        "HealthStatus": {
          "type": "string",
          "enum": [
            "Stale"
          ]
        },
        "HealthStatusMessage": {
          "type": "string"
        },
        "Kind": {
          "type": "string",
          "minLength": 1
        },
        "LastUpdated": {
          "type": "string"
        },
        "MachineId": {
          "type": "string",
          "minLength": 1
        },
        "Name": {
          "type": "string"
        },
        "Namespace": {
          "type": "string"
        },
        "ResourceId": {
          "type": "string",
          "format": "uuid"
        },
        "ResourceSourceId": {
          "type": "string"
        },
        "SourceType": {
          "type": "string",
          "enum": [
            "KubernetesMonitor",
            "ArgoCDInstance",
            "ArgoCDApplication"
          ]
        },
        "SyncStatus": {
          "type": "string"
        },
        "SyncStatusMessage": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "KubernetesMachineLiveStatusResource": {
      "type": "object",
      "required": [
        "MachineId",
        "Resources",
        "Status"
      ],
      "properties": {
        "MachineId": {
          "type": "string",
          "example": "Machines-1"
        },
        "Resources": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/KubernetesLiveStatusResource"
          }
        },
        "Status": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "KubernetesMonitorResource": {
      "type": "object",
      "required": [
        "Id",
        "InstallationId",
        "MachineId",
        "SpaceId"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "example": "KubernetesMonitors-1"
        },
        "InstallationId": {
          "type": "string",
          "format": "uuid"
        },
        "MachineId": {
          "type": "string",
          "example": "Machines-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "LatestProjectDeployment": {
      "type": "object",
      "required": [
        "ProjectId",
        "ProjectLogo",
        "ProjectName",
        "ServerTask"
      ],
      "properties": {
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ProjectLogo": {
          "type": "string",
          "minLength": 1
        },
        "ProjectName": {
          "type": "string",
          "minLength": 1
        },
        "ServerTask": {
          "$ref": "#/definitions/TaskResource"
        }
      },
      "additionalProperties": false
    },
    "LatestProjectDeploymentPaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/LatestProjectDeployment"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "LetsEncryptConfigurationResource": {
      "type": "object",
      "required": [
        "Enabled"
      ],
      "properties": {
        "AcceptLetsEncryptTermsOfService": {
          "type": "boolean"
        },
        "CertificateExpiryDate": {
          "type": "string",
          "format": "date-time"
        },
        "CertificateThumbprint": {
          "type": "string"
        },
        "DnsName": {
          "type": "string"
        },
        "Enabled": {
          "type": "boolean"
        },
        "HttpsPort": {
          "type": "integer",
          "format": "int32"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IPAddress": {
          "type": "string"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Path": {
          "type": "string"
        },
        "RegistrationEmailAddress": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "Library": {
      "type": "object",
      "properties": {
        "LibraryVariableSetId": {
          "type": "string"
        },
        "LibraryVariableSetName": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Templates": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          }
        },
        "Variables": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/PropertyValueResource"
          }
        }
      },
      "additionalProperties": false
    },
    "LibraryDocumentCounts": {
      "type": "object",
      "properties": {
        "Certificates": {
          "type": "integer",
          "format": "int32"
        },
        "Packages": {
          "type": "integer",
          "format": "int32"
        },
        "VariableSets": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "LibraryVariableSetProjectUsage": {
      "type": "object",
      "properties": {
        "IsCurrentlyBeingUsedInProject": {
          "type": "boolean"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ProjectName": {
          "type": "string"
        },
        "ProjectSlug": {
          "type": "string"
        },
        "Releases": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/LibraryVariableSetReleaseUsageEntry"
          }
        },
        "RunbookSnapshots": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/LibraryVariableSetRunbookSnapshotUsageEntry"
          }
        }
      },
      "additionalProperties": false
    },
    "LibraryVariableSetReleaseUsageEntry": {
      "type": "object",
      "properties": {
        "ReleaseId": {
          "type": "string",
          "example": "Releases-1"
        },
        "ReleaseVersion": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "LibraryVariableSetResource": {
      "type": "object",
      "properties": {
        "ContentType": {
          "type": "string",
          "description": "Describes the purpose of the variable set. Clients can use this to offer an editing experience appropriately.",
          "enum": [
            "Variables",
            "ScriptModule"
          ]
        },
        "Description": {
          "type": "string",
          "description": "Gets or sets a description of this variable set that explains the purpose of the variable set to other users. This field may contain markdown."
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "description": "Gets or sets the name of this variable set. This should be short, preferably 5-20 characters."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Templates": {
          "type": "array",
          "description": "Gets the variable templates.",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          }
        },
        "VariableSetId": {
          "type": "string",
          "description": "Gets or sets the id of the associated variable set."
        },
        "Version": {
          "type": "integer",
          "description": "Gets or sets the version number.",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "LibraryVariableSetResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/LibraryVariableSetResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "LibraryVariableSetRunbookSnapshotUsageEntry": {
      "type": "object",
      "properties": {
        "SnapshotId": {
          "type": "string"
        },
        "SnapshotName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "LibraryVariableSetUsageEntry": {
      "type": "object",
      "properties": {
        "LibraryVariableSetId": {
          "type": "string"
        },
        "LibraryVariableSetName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "LicenseLimitStatusResource": {
      "type": "object",
      "properties": {
        "CurrentUsage": {
          "type": "integer",
          "format": "int32"
        },
        "Disposition": {
          "type": "string",
          "enum": [
            "Information",
            "Notice",
            "Warning",
            "Error"
          ]
        },
        "EffectiveLimit": {
          "type": "integer",
          "format": "int32"
        },
        "EffectiveLimitDescription": {
          "type": "string"
        },
        "IsUnlimited": {
          "type": "boolean"
        },
        "LicensedLimit": {
          "type": "integer",
          "format": "int32"
        },
        "LicenseLimitDescription": {
          "type": "string"
        },
        "LimitStatus": {
          "type": "string",
          "enum": [
            "UnderLimit",
            "AlmostAtLimit",
            "AtLimit",
            "InOverrun",
            "ExceedingLimit"
          ]
        },
        "Message": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "TargetTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "LicenseLimitUsageResource": {
      "type": "object",
      "properties": {
        "CurrentUsage": {
          "type": "integer",
          "format": "int32"
        },
        "Disposition": {
          "type": "string",
          "enum": [
            "Information",
            "Notice",
            "Warning",
            "Error"
          ]
        },
        "EffectiveLimit": {
          "type": "integer",
          "format": "int32"
        },
        "EffectiveLimitDescription": {
          "type": "string"
        },
        "IsUnlimited": {
          "type": "boolean"
        },
        "LicensedLimit": {
          "type": "integer",
          "format": "int32"
        },
        "LicenseLimitDescription": {
          "type": "string"
        },
        "LimitStatus": {
          "type": "string",
          "enum": [
            "UnderLimit",
            "AlmostAtLimit",
            "AtLimit",
            "InOverrun",
            "ExceedingLimit"
          ]
        },
        "LimitUsageDescription": {
          "type": "string"
        },
        "Message": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "TargetTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "LicenseMessageResource": {
      "type": "object",
      "properties": {
        "Disposition": {
          "type": "string",
          "enum": [
            "Information",
            "Notice",
            "Warning",
            "Error"
          ]
        },
        "Message": {
          "type": "string"
        },
        "MessagePolicy": {
          "type": "string",
          "enum": [
            "LicensePeriodPolicy",
            "AuditStreamPolicy",
            "InsightsLicensePolicy",
            "TimeLimitedPolicy",
            "MaintenancePeriodPolicy",
            "TimeLimitedTestLicensePolicy",
            "CommunityEditionPolicy",
            "NodeLimitPolicy"
          ]
        }
      },
      "additionalProperties": false
    },
    "LicenseResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LicenseText": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "SerialNumber": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "LicenseStatusResource": {
      "type": "object",
      "properties": {
        "ComplianceSummary": {
          "type": "string"
        },
        "DaysToEffectiveExpiryDate": {
          "type": "integer",
          "format": "int32"
        },
        "DoesExpiryBlockKeyActivities": {
          "type": "boolean"
        },
        "EffectiveClusterTaskLimit": {
          "type": "integer",
          "format": "int32"
        },
        "EffectiveExpiryDate": {
          "type": "string"
        },
        "EffectiveNodeTaskLimit": {
          "type": "integer",
          "format": "int32"
        },
        "EffectiveStartDate": {
          "type": "string"
        },
        "HostingEnvironment": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsClusterTaskLimitControlledByLicense": {
          "type": "boolean"
        },
        "IsCompliant": {
          "type": "boolean"
        },
        "IsInitialisationLicense": {
          "type": "boolean"
        },
        "IsNodeTaskLimitControlledByLicense": {
          "type": "boolean"
        },
        "IsPtm": {
          "type": "boolean"
        },
        "IsTrial": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Limits": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/LicenseLimitStatusResource"
          }
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Messages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/LicenseMessageResource"
          }
        },
        "PermissionsMode": {
          "type": "string",
          "enum": [
            "Unspecified",
            "Restricted",
            "Full"
          ]
        },
        "SerialNumber": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "LicenseUsageResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsPtm": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Limits": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/LicenseLimitUsageResource"
          }
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "SpacesUsage": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SpaceLicenseUsageResource"
          }
        }
      },
      "additionalProperties": false
    },
    "LifecycleProgressionResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NextDeployments": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "NextDeploymentsMinimumRequired": {
          "type": "integer",
          "format": "int32"
        },
        "Phases": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PhaseProgressionResource"
          }
        }
      },
      "additionalProperties": false
    },
    "LifecycleResource": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "Phases": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PhaseResource"
          },
          "readOnly": true
        },
        "ReleaseRetentionPolicy": {
          "$ref": "#/definitions/RetentionPeriod"
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TentacleRetentionPolicy": {
          "$ref": "#/definitions/RetentionPeriod"
        }
      },
      "additionalProperties": false
    },
    "LifecycleResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/LifecycleResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ListApiMetadata": {
      "type": "object",
      "properties": {
        "ApiEndpoint": {
          "type": "string"
        },
        "SelectMode": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "LiveResourceDiff": {
      "type": "object",
      "required": [
        "Diff",
        "Left",
        "Right"
      ],
      "properties": {
        "Diff": {
          "type": "string",
          "minLength": 1
        },
        "Left": {
          "type": "string",
          "minLength": 1
        },
        "Right": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "LiveResourceDiffV2": {
      "type": "object",
      "required": [
        "Diff",
        "Left",
        "Right"
      ],
      "properties": {
        "Diff": {
          "type": "string",
          "minLength": 1
        },
        "Left": {
          "type": "string",
          "minLength": 1
        },
        "Right": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "LiveStatusSummaryResource": {
      "type": "object",
      "required": [
        "HealthStatus",
        "LastUpdated",
        "Status",
        "SyncStatus"
      ],
      "properties": {
        "HealthStatus": {
          "type": "string",
          "minLength": 1
        },
        "LastUpdated": {
          "type": "string"
        },
        "Status": {
          "type": "string",
          "minLength": 1
        },
        "SyncStatus": {
          "type": "string",
          "minLength": 1
        },
        "SyncStatusMessage": {
          "type": "string"
        },
        "TotalOrphanCount": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "LoadBalancerPingResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsInMaintenanceMode": {
          "type": "boolean"
        },
        "IsOffline": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastSeen": {
          "type": "string",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "MaxConcurrentTasks": {
          "type": "integer",
          "format": "int32"
        },
        "Name": {
          "type": "string"
        },
        "Version": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "LoginInitiatedResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProviderName": {
          "type": "string"
        },
        "WasLoginInitiated": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "LoginState": {
      "type": "object",
      "properties": {
        "RedirectAfterLoginTo": {
          "type": "string",
          "description": "The Url, relative to the portal site, to redirect to post successful login."
        },
        "UsingSecureConnection": {
          "type": "boolean",
          "description": "Whether the client says it's using a secure connection. We need this because SSL offloading can obscure this and the server cannot tell whether the client initiated the call using a secure connection."
        }
      },
      "additionalProperties": false
    },
    "LoginUserCommand": {
      "type": "object",
      "required": [
        "Password",
        "Username"
      ],
      "properties": {
        "Password": {
          "type": "string",
          "description": "The password to log in with.",
          "minLength": 1
        },
        "RememberMe": {
          "type": "boolean",
          "description": "Whether the cookie should be persistent."
        },
        "RemoteIpAddress": {
          "type": "string",
          "description": "IP Address of the user"
        },
        "State": {
          "$ref": "#/definitions/LoginState"
        },
        "Username": {
          "type": "string",
          "description": "The username to log in with.",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "MachineBasedResource": {
      "type": "object",
      "properties": {
        "Architecture": {
          "type": "string"
        },
        "Endpoint": {
          "$ref": "#/definitions/EndpointResource"
        },
        "HasLatestCalamari": {
          "type": "boolean"
        },
        "HealthStatus": {
          "type": "string",
          "enum": [
            "Healthy",
            "Unavailable",
            "Unknown",
            "HasWarnings",
            "Unhealthy"
          ]
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "IsInProcess": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "MachinePolicyId": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "OperatingSystem": {
          "type": "string"
        },
        "OperatingSystemVersion": {
          "type": "string"
        },
        "ShellName": {
          "type": "string"
        },
        "ShellVersion": {
          "type": "string"
        },
        "SkipInitialHealthCheck": {
          "type": "boolean"
        },
        "Slug": {
          "type": "string"
        },
        "StatusSummary": {
          "type": "string"
        },
        "Thumbprint": {
          "type": "string"
        },
        "Uri": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "MachineCleanupPolicyResource": {
      "type": "object",
      "properties": {
        "DeleteMachinesBehavior": {
          "type": "string",
          "enum": [
            "DoNotDelete",
            "DeleteUnavailableMachines"
          ]
        },
        "DeleteMachinesElapsedTimeSpan": {
          "type": "string",
          "format": "date-span"
        }
      },
      "additionalProperties": false
    },
    "MachineConnectionStatus": {
      "type": "object",
      "properties": {
        "CurrentTentacleVersion": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastChecked": {
          "type": "string",
          "format": "date-time"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Logs": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActivityLogElement"
          }
        },
        "MachineId": {
          "type": "string"
        },
        "Status": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "MachineConnectivityPolicyResource": {
      "type": "object",
      "properties": {
        "MachineConnectivityBehavior": {
          "type": "string",
          "enum": [
            "ExpectedToBeOnline",
            "MayBeOfflineAndCanBeSkipped"
          ]
        }
      },
      "additionalProperties": false
    },
    "MachineDeploymentPreview": {
      "type": "object",
      "properties": {
        "HasLatestCalamari": {
          "type": "boolean"
        },
        "HealthStatus": {
          "type": "string",
          "enum": [
            "Healthy",
            "HasWarnings",
            "Unhealthy",
            "Unavailable"
          ]
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "MachineHealthCheckPolicyResource": {
      "type": "object",
      "properties": {
        "BashHealthCheckPolicy": {
          "$ref": "#/definitions/MachineScriptPolicyResource"
        },
        "HealthCheckCron": {
          "type": "string"
        },
        "HealthCheckCronTimezone": {
          "type": "string"
        },
        "HealthCheckInterval": {
          "type": "string",
          "format": "date-span"
        },
        "HealthCheckType": {
          "type": "string",
          "enum": [
            "RunScript",
            "OnlyConnectivity"
          ]
        },
        "PowerShellHealthCheckPolicy": {
          "$ref": "#/definitions/MachineScriptPolicyResource"
        }
      },
      "additionalProperties": false
    },
    "MachinePackageCacheRetentionPolicyResource": {
      "type": "object",
      "properties": {
        "PackageUnit": {
          "type": "string",
          "enum": [
            "Items"
          ]
        },
        "QuantityOfPackagesToKeep": {
          "type": "integer",
          "format": "int32"
        },
        "QuantityOfVersionsToKeep": {
          "type": "integer",
          "format": "int32"
        },
        "Strategy": {
          "type": "string",
          "enum": [
            "Default",
            "Quantities"
          ]
        },
        "VersionUnit": {
          "type": "string",
          "enum": [
            "Items"
          ]
        }
      },
      "additionalProperties": false
    },
    "MachinePolicyResource": {
      "type": "object",
      "properties": {
        "ConnectionConnectTimeout": {
          "type": "string",
          "format": "date-span"
        },
        "ConnectionRetryCountLimit": {
          "type": "integer",
          "format": "int32"
        },
        "ConnectionRetrySleepInterval": {
          "type": "string",
          "format": "date-span"
        },
        "ConnectionRetryTimeLimit": {
          "type": "string",
          "format": "date-span"
        },
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDefault": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "MachineCleanupPolicy": {
          "$ref": "#/definitions/MachineCleanupPolicyResource"
        },
        "MachineConnectivityPolicy": {
          "$ref": "#/definitions/MachineConnectivityPolicyResource"
        },
        "MachineHealthCheckPolicy": {
          "$ref": "#/definitions/MachineHealthCheckPolicyResource"
        },
        "MachinePackageCacheRetentionPolicy": {
          "$ref": "#/definitions/MachinePackageCacheRetentionPolicyResource"
        },
        "MachineRpcCallRetryPolicy": {
          "$ref": "#/definitions/MachineRpcCallRetryPolicyResource"
        },
        "MachineUpdatePolicy": {
          "$ref": "#/definitions/MachineUpdatePolicyResource"
        },
        "Name": {
          "type": "string"
        },
        "PollingRequestQueueTimeout": {
          "type": "string",
          "format": "date-span"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "MachinePolicyResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/MachinePolicyResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "MachineResource": {
      "type": "object",
      "properties": {
        "Architecture": {
          "type": "string"
        },
        "Endpoint": {
          "$ref": "#/definitions/EndpointResource"
        },
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "HasLatestCalamari": {
          "type": "boolean"
        },
        "HealthStatus": {
          "type": "string",
          "enum": [
            "Healthy",
            "Unavailable",
            "Unknown",
            "HasWarnings",
            "Unhealthy"
          ]
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "IsInProcess": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "MachinePolicyId": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "OperatingSystem": {
          "type": "string"
        },
        "OperatingSystemVersion": {
          "type": "string"
        },
        "Roles": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ShellName": {
          "type": "string"
        },
        "ShellVersion": {
          "type": "string"
        },
        "SkipInitialHealthCheck": {
          "type": "boolean"
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "StatusSummary": {
          "type": "string"
        },
        "TenantedDeploymentParticipation": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "TenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Thumbprint": {
          "type": "string"
        },
        "Uri": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "MachineResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/MachineResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "MachineResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/MachineResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "MachineRpcCallRetryPolicyResource": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean"
        },
        "HealthCheckRetryDuration": {
          "type": "string",
          "format": "date-span"
        },
        "RetryDuration": {
          "type": "string",
          "format": "date-span"
        }
      },
      "additionalProperties": false
    },
    "MachineScriptPolicyResource": {
      "type": "object",
      "properties": {
        "RunType": {
          "type": "string",
          "enum": [
            "InheritFromDefault",
            "Inline",
            "OnlyConnectivity"
          ]
        },
        "ScriptBody": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "MachineUpdatePolicyResource": {
      "type": "object",
      "properties": {
        "CalamariUpdateBehavior": {
          "type": "string",
          "enum": [
            "UpdateOnDeployment",
            "UpdateOnNewMachine",
            "UpdateAlways"
          ]
        },
        "KubernetesAgentUpdateBehavior": {
          "type": "string",
          "enum": [
            "NeverUpdate",
            "Update",
            "Block"
          ]
        },
        "TentacleUpdateAccountId": {
          "type": "string"
        },
        "TentacleUpdateBehavior": {
          "type": "string",
          "enum": [
            "NeverUpdate",
            "Update"
          ]
        }
      },
      "additionalProperties": false
    },
    "MaintenanceConfigurationResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsInMaintenanceMode": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "ManifestSummaryResource": {
      "type": "object",
      "properties": {
        "Annotations": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "CreationTimestamp": {
          "type": "string",
          "format": "date-time"
        },
        "Kind": {
          "type": "string"
        },
        "Labels": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "MarkEphemeralEnvironmentDeprovisioningSuccessfulResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "MarkEphemeralEnvironmentProvisioningSuccessfulResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "Metadata": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "Types": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TypeMetadata"
          }
        }
      },
      "additionalProperties": false
    },
    "MigrationImportResource": {
      "type": "object",
      "properties": {
        "DeletePackageOnCompletion": {
          "type": "boolean"
        },
        "FailureCallbackUri": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDryRun": {
          "type": "boolean",
          "example": true
        },
        "IsEncryptedPackage": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "OverwriteExisting": {
          "type": "boolean"
        },
        "PackageFeedSpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "PackageId": {
          "type": "string",
          "example": "MyAwesomeOctopusMigration"
        },
        "PackageVersion": {
          "type": "string",
          "example": "1.0.0"
        },
        "Password": {
          "type": "string"
        },
        "SuccessCallbackUri": {
          "type": "string"
        },
        "TaskId": {
          "type": "string",
          "description": "This will be populated with the TaskId that gets queued for this migration",
          "example": "ServerTasks-1234"
        }
      },
      "additionalProperties": false
    },
    "MigrationPartialExportResource": {
      "type": "object",
      "properties": {
        "DestinationApiKey": {
          "type": "string"
        },
        "DestinationPackageFeed": {
          "type": "string"
        },
        "DestinationPackageFeedSpaceId": {
          "type": "string"
        },
        "EncryptPackage": {
          "type": "boolean",
          "example": true
        },
        "FailureCallbackUri": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IgnoreCertificates": {
          "type": "boolean"
        },
        "IgnoreDeployments": {
          "type": "boolean"
        },
        "IgnoreMachines": {
          "type": "boolean"
        },
        "IgnoreTenants": {
          "type": "boolean"
        },
        "IncludeTaskLogs": {
          "type": "boolean",
          "example": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "PackageId": {
          "type": "string",
          "example": "MyAwesomeOctopusMigration"
        },
        "PackageVersion": {
          "type": "string",
          "example": "1.0.0"
        },
        "Password": {
          "type": "string"
        },
        "Projects": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Projects-1"
          ]
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "SuccessCallbackUri": {
          "type": "string"
        },
        "TaskId": {
          "type": "string",
          "example": "ServerTasks-1234"
        }
      },
      "additionalProperties": false
    },
    "MissingPackageInfo": {
      "type": "object",
      "required": [
        "Id",
        "Version"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "minLength": 1
        },
        "Version": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "MissingTenantCommonVariable": {
      "type": "object",
      "required": [
        "LibraryVariableSetId",
        "Scope",
        "TemplateId"
      ],
      "properties": {
        "LibraryVariableSetId": {
          "type": "string",
          "example": "LibraryVariableSets-1"
        },
        "LibraryVariableSetName": {
          "type": "string"
        },
        "Scope": {
          "$ref": "#/definitions/CommonVariableScope"
        },
        "Template": {
          "$ref": "#/definitions/ActionTemplateParameterResource"
        },
        "TemplateId": {
          "type": "string",
          "minLength": 1
        },
        "Value": {
          "$ref": "#/definitions/PropertyValueResource"
        }
      },
      "additionalProperties": false
    },
    "MissingTenantProjectVariable": {
      "type": "object",
      "required": [
        "ProjectId",
        "Scope",
        "TemplateId",
        "Value"
      ],
      "properties": {
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ProjectName": {
          "type": "string"
        },
        "Scope": {
          "$ref": "#/definitions/ProjectVariableScope"
        },
        "Template": {
          "$ref": "#/definitions/ActionTemplateParameterResource"
        },
        "TemplateId": {
          "type": "string",
          "minLength": 1
        },
        "Value": {
          "$ref": "#/definitions/PropertyValueResource"
        }
      },
      "additionalProperties": false
    },
    "MissingVariableResource": {
      "type": "object",
      "properties": {
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "LibraryVariableSetId": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectId": {
          "type": "string"
        },
        "VariableTemplateId": {
          "type": "string"
        },
        "VariableTemplateName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ModifyAccountCommand": {
      "type": "object",
      "required": [
        "AccountId",
        "Details",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "AccountId": {
          "type": "string",
          "example": "Accounts-1"
        },
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/AccountDetailsResource"
        },
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantedDeploymentParticipation": {
          "type": "string"
        },
        "TenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyActionTemplateCommand": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "description": "The description of the Action Template."
        },
        "GitDependencies": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitDependencyResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "The id of the existing Action Template.",
          "example": "ActionTemplates-1"
        },
        "Inputs": {
          "$ref": "#/definitions/StepPackageInputsResource"
        },
        "Name": {
          "type": "string",
          "description": "The name of the Action Template.",
          "minLength": 1
        },
        "Packages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PackageReferenceResource"
          }
        },
        "Parameters": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          }
        },
        "Properties": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/PropertyValueResource"
          }
        },
        "SpaceId": {
          "type": "string",
          "description": "The id of the Space that contains the Action Template.",
          "example": "Spaces-1"
        },
        "StepPackageVersion": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ModifyActionTemplateLogoResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifyApprovalCommand": {
      "type": "object",
      "required": [
        "Id",
        "Notes",
        "ServerTaskApprovalId",
        "SpaceId",
        "Status"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "description": "The id of the Approval."
        },
        "Notes": {
          "type": "string",
          "description": "A reason for approving or rejecting the deployment",
          "minLength": 1
        },
        "ServerTaskApprovalId": {
          "type": "string",
          "description": "The id of the Server Task Approval."
        },
        "SpaceId": {
          "type": "string",
          "description": "The id of the space for the Approval.",
          "example": "Spaces-1"
        },
        "Status": {
          "type": "string",
          "description": "Approve or reject the deployment. [\"Approved\", \"Rejected\"]"
        }
      },
      "additionalProperties": false
    },
    "ModifyApprovalRuleCommand": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "AllowSelfApproval": {
          "type": "boolean",
          "description": "Whether deployment creators are allowed to approve their own deployments"
        },
        "ApprovingTeamIds": {
          "type": "array",
          "description": "A list of team ids who are authorized to approve deployments",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Teams-1",
            "..."
          ]
        },
        "ApprovingUserIds": {
          "type": "array",
          "description": "A list of user ids who are authorized to approve deployments",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Users-1",
            "..."
          ]
        },
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "IdScopes": {
          "type": "array",
          "description": "A list of project and environment ids this approval rule will apply to",
          "items": {
            "$ref": "#/definitions/ApprovalRuleIdScopeResource"
          }
        },
        "IsDisabled": {
          "type": "boolean",
          "description": "Whether this approval rule is disabled"
        },
        "MinimumApproversRequired": {
          "type": "integer",
          "description": "Set a number of minimum approvers required to authorize the deployment",
          "format": "int32",
          "maximum": 100,
          "minimum": 1
        },
        "Name": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "ScopingStrategy": {
          "type": "string",
          "description": "How to scope this approval rule. [\"Tag\", \"Id\"]"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TagScopes": {
          "type": "array",
          "description": "A list of project and environment tags this approval rule will apply to",
          "items": {
            "$ref": "#/definitions/ApprovalRuleTagScopeResource"
          }
        },
        "TenantApprovalStrategy": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ModifyAuditStreamConfigurationCommand": {
      "type": "object",
      "properties": {
        "Active": {
          "type": "boolean"
        },
        "Description": {
          "type": "string"
        },
        "StreamConfigurationResource": {
          "$ref": "#/definitions/IAuditStreamConfigurationResource"
        }
      },
      "additionalProperties": false
    },
    "ModifyCertificateCommand": {
      "type": "object",
      "description": "Modifies an existing certificate",
      "required": [
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "EnvironmentIds": {
          "type": "array",
          "description": "The environments allowed to use this certificate",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Id": {
          "type": "string",
          "description": "The ID of the certificate",
          "example": "Certificates-1"
        },
        "Name": {
          "type": "string",
          "description": "The name of the certificate",
          "minLength": 1
        },
        "Notes": {
          "type": "string",
          "description": "Additional information on the certificate"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space",
          "example": "Spaces-1"
        },
        "TenantedDeploymentParticipation": {
          "type": "string",
          "description": "The kind of deployments where this certificate should be included",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "TenantIds": {
          "type": "array",
          "description": "The tenants this certificate should be associated with",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTags": {
          "type": "array",
          "description": "The tags this certificate should be associated with",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyChannelCommand": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "AutomaticEphemeralEnvironmentDeployments": {
          "type": "boolean"
        },
        "CustomFieldDefinitions": {
          "type": "array",
          "description": "Custom fields (FieldName plus a human-facing Description) that become mandatory when creating a release in this channel. Omit to keep the current definitions; an empty list clears them.",
          "items": {
            "$ref": "#/definitions/ChannelCustomFieldDefinitionResource"
          }
        },
        "Description": {
          "type": "string"
        },
        "EphemeralEnvironmentNameTemplate": {
          "type": "string",
          "maxLength": 1000
        },
        "GitReferenceRules": {
          "type": "array",
          "description": "Git reference patterns (e.g. 'refs/heads/main', 'refs/heads/feature/*') restricting which branches or tags can create releases in this channel. Only valid for version-controlled (Config-as-Code) projects. Omit to keep the current rules; an empty list clears them.",
          "items": {
            "type": "string"
          }
        },
        "GitResourceRules": {
          "type": "array",
          "description": "Rules restricting which Git refs may be used for external Git dependencies referenced by deployment steps. Each rule targets step Git dependencies via GitDependencyActions (DeploymentActionSlug plus GitDependencyName) and lists the allowed Git reference patterns in Rules. Omit to keep the current rules; an empty list clears them.",
          "items": {
            "$ref": "#/definitions/ChannelGitResourceRuleResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource.",
          "example": "Channels-1"
        },
        "IsDefault": {
          "type": "boolean"
        },
        "LifecycleId": {
          "type": "string",
          "description": "The lifecycle for this channel. Must be null for ephemeral environment channels."
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ParentEnvironmentId": {
          "type": "string",
          "description": "The parent environment for all ephemeral environments created in this channel. Required for ephemeral environment channels.",
          "example": "Environments-1"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "Rules": {
          "type": "array",
          "description": "Version rules restricting which package versions may be used when creating a release in this channel. Each rule targets step packages via ActionPackages (DeploymentAction is the step name or ID, PackageReference the package reference name or ID) and constrains versions with a NuGet-style VersionRange (e.g. '[1.0,2.0)') and/or a Tag regex matched against the package's pre-release tag (e.g. '^$' for stable versions only). Keep each existing rule's Id; leave it blank on new rules. Omit to keep the current rules; an empty list clears them.",
          "items": {
            "$ref": "#/definitions/ChannelVersionRuleResource"
          }
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantTags": {
          "type": "array",
          "description": "Canonical tenant tag names in 'TagSet/Tag' format restricting which tenants can deploy releases from this channel. Omit to keep the current tags; an empty collection clears them.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyCommonVariablesByTenantIdCommand": {
      "type": "object",
      "required": [
        "SpaceId",
        "TenantId",
        "Variables"
      ],
      "properties": {
        "ConcurrencyToken": {
          "type": "string",
          "description": "The concurrency token returned when reading the tenant's variables. Always pass it back so the write is rejected if someone else changed the variables since your read; omitting it skips the check and risks silently overwriting their changes."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        },
        "Variables": {
          "type": "array",
          "description": "The complete set of common variable values for the tenant; existing values omitted here are deleted. Each item is an object: 'Id' (the existing value's ID when updating; omit when adding), 'OwnerId' (the library variable set ID), 'TemplateId' (the variable template ID), 'Value' (a plain string for non-sensitive values, or {\"HasValue\": true, \"NewValue\": \"secret\"} for sensitive ones), and 'Scope' ({\"EnvironmentIds\": [...]} limiting the value to those environments; empty applies to all).",
          "items": {
            "$ref": "#/definitions/TenantCommonVariablePayload"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyCommonVariablesByTenantIdResponse": {
      "type": "object",
      "required": [
        "ConcurrencyToken",
        "TenantId",
        "Variables"
      ],
      "properties": {
        "ConcurrencyToken": {
          "type": "string",
          "minLength": 1
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        },
        "Variables": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TenantCommonVariableV2"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyCompliancePolicyCommand": {
      "type": "object",
      "required": [
        "ConditionsRego",
        "GitRef",
        "Name",
        "ScopeRego",
        "Slug",
        "ViolationAction"
      ],
      "properties": {
        "ChangeDescription": {
          "type": "string"
        },
        "ConditionsRego": {
          "type": "string",
          "minLength": 1
        },
        "Description": {
          "type": "string"
        },
        "GitRef": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ScopeRego": {
          "type": "string",
          "minLength": 1
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "ViolationAction": {
          "type": "string",
          "minLength": 1
        },
        "ViolationReason": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ModifyCompliancePolicyVersionActivationStatusCommand": {
      "type": "object",
      "required": [
        "IsActive",
        "Slug",
        "Version"
      ],
      "properties": {
        "IsActive": {
          "type": "boolean"
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "Version": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ModifyCurrentLicenseCommand": {
      "type": "object",
      "description": "Updates the license for the Octopus cluster.",
      "properties": {
        "LicenseText": {
          "type": "string"
        },
        "SerialNumber": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ModifyDashboardConfigurationCommand": {
      "type": "object",
      "description": "Modifies the dashboard configuration for the current user per space",
      "required": [
        "SpaceId"
      ],
      "properties": {
        "HideInactiveProjects": {
          "type": "boolean",
          "description": "Whether to hide inactive projects on the dashboard."
        },
        "IncludedEnvironmentIds": {
          "type": "array",
          "description": "The ids of environments to be displayed on the dashboard.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "IncludedEnvironmentTags": {
          "type": "array",
          "description": "The canonical tag names of environments to display on the dashboard.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "IncludedProjectGroupIds": {
          "type": "array",
          "description": "The ids of project groups to be displayed on the dashboard.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "IncludedProjectIds": {
          "type": "array",
          "description": "The ids of projects to be displayed on the dashboard.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Projects-1",
            "..."
          ]
        },
        "IncludedProjectTags": {
          "type": "array",
          "description": "The canonical tag names of projects to display on the dashboard.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "IncludedTenantIds": {
          "type": "array",
          "description": "The ids of tenants to be displayed on the dashboard.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "IncludedTenantTags": {
          "type": "array",
          "description": "The canonical tag names to display on the dashboard.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ProjectLimit": {
          "type": "integer",
          "description": "The maximum number of projects to display on the dashboard",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "description": "The id of the space for the DashboardConfiguration.",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyDefaultRetentionPolicyCommand": {
      "type": "object",
      "required": [
        "Id",
        "RetentionType",
        "SpaceId"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "description": "The id of the default retention policy.",
          "example": "RetentionPolicies-1"
        },
        "RetentionType": {
          "type": "string",
          "description": "The type of the default retention policy. [\"MachinePackageCache\", \"LifecycleRetention\", \"TentacleRetention\", \"RunbookRetention\"]",
          "example": "LifecycleRelease"
        },
        "SpaceId": {
          "type": "string",
          "description": "The id of the space that contains the default retention policy.",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyDeploymentFreezeCommand": {
      "type": "object",
      "required": [
        "End",
        "Id",
        "Name",
        "Start"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "End": {
          "type": "string",
          "format": "date-time"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "ProjectEnvironmentScope": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          }
        },
        "RecurringSchedule": {
          "$ref": "#/definitions/RecurringScheduleResource"
        },
        "Start": {
          "type": "string",
          "format": "date-time"
        },
        "TenantProjectEnvironmentScope": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "$ref": "#/definitions/TenantProjectEnvironment"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyDeploymentFreezeResponse": {
      "type": "object",
      "required": [
        "End",
        "Id",
        "Name",
        "Start"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "End": {
          "type": "string",
          "format": "date-time"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectEnvironmentScope": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          }
        },
        "RecurringSchedule": {
          "$ref": "#/definitions/RecurringScheduleResource"
        },
        "Start": {
          "type": "string",
          "format": "date-time"
        },
        "TenantProjectEnvironmentScope": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "$ref": "#/definitions/TenantProjectEnvironment"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyDeploymentProcessInDatabaseCommand": {
      "type": "object",
      "description": "Modifies a deployment process. Only allowed for deployment processes owned by a project (cannot be used to change the deployment process owned by a release).",
      "required": [
        "ProjectId",
        "SpaceId",
        "Steps",
        "Version"
      ],
      "properties": {
        "ChangeDescription": {
          "type": "string"
        },
        "LastSnapshotId": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Steps": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentStepResource"
          }
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ModifyDeploymentProcessInGitCommand": {
      "type": "object",
      "description": "Modifies a deployment process. Only allowed for deployment processes owned by a project (cannot be used to change the deployment process owned by a release).",
      "required": [
        "GitRef",
        "ProjectId",
        "SpaceId",
        "Steps",
        "Version"
      ],
      "properties": {
        "ChangeDescription": {
          "type": "string"
        },
        "GitRef": {
          "type": "string"
        },
        "LastSnapshotId": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Steps": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentStepResource"
          }
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ModifyDeploymentSettingsInDatabaseCommand": {
      "type": "object",
      "description": "Modifies deployment settings for a project.",
      "required": [
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "CancelQueuedTasks": {
          "type": "boolean",
          "description": "When enabled, creating a new deployment will cancel all previously queued deployments to the same project/environment/tenant"
        },
        "CancelRunningTasks": {
          "type": "boolean",
          "description": "When enabled, completing a deployment will cancel older running or paused deployments to the same project/environment/tenant"
        },
        "ChangeDescription": {
          "type": "string",
          "description": "The description for the deployment settings modification."
        },
        "ConnectivityPolicy": {
          "$ref": "#/definitions/DeploymentConnectivityPolicy"
        },
        "DefaultGuidedFailureMode": {
          "type": "string",
          "description": "The action related to when a deployment error occurs. (IE: Enabling guided failure will pause the deployment failure to allow error correction before proceeding)",
          "enum": [
            "EnvironmentDefault",
            "Off",
            "On"
          ]
        },
        "DefaultToSkipIfAlreadyInstalled": {
          "type": "boolean",
          "description": "If true, and the version of the package being deployed is already present on the machine, its re-deployment will be skipped."
        },
        "DeploymentChangesTemplate": {
          "type": "string",
          "description": "A markdown template generated for each deployment's changes."
        },
        "FailTargetDiscovery": {
          "type": "boolean",
          "description": "Fail cloud discovery steps if no targets found"
        },
        "ForcePackageDownload": {
          "type": "boolean",
          "description": "Option to force re-downloading packages for deployment."
        },
        "ProjectId": {
          "type": "string",
          "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
          "example": "Projects-1"
        },
        "ReleaseNotesTemplate": {
          "type": "string",
          "description": "Template text pre-filled as the release notes when a release of this project is created; may contain Octopus variable expressions. Omitting this clears the project's existing template."
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        },
        "VersioningStrategy": {
          "$ref": "#/definitions/VersioningStrategyResource"
        }
      },
      "additionalProperties": false
    },
    "ModifyDeploymentSettingsInGitCommand": {
      "type": "object",
      "description": "Modifies deployment settings for a project.",
      "required": [
        "GitRef",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "CancelQueuedTasks": {
          "type": "boolean",
          "description": "When enabled, creating a new deployment will cancel all previously queued deployments to the same project/environment/tenant"
        },
        "CancelRunningTasks": {
          "type": "boolean",
          "description": "When enabled, completing a deployment will cancel older running or paused deployments to the same project/environment/tenant"
        },
        "ChangeDescription": {
          "type": "string",
          "description": "Used as the Git commit message. Omit to use the default message 'Update deployment settings'."
        },
        "ConnectivityPolicy": {
          "$ref": "#/definitions/DeploymentConnectivityPolicy"
        },
        "DefaultGuidedFailureMode": {
          "type": "string",
          "description": "The action related to when a deployment error occurs. (IE: Enabling guided failure will pause the deployment failure to allow error correction before proceeding)",
          "enum": [
            "EnvironmentDefault",
            "Off",
            "On"
          ]
        },
        "DefaultToSkipIfAlreadyInstalled": {
          "type": "boolean",
          "description": "If true, and the version of the package being deployed is already present on the machine, its re-deployment will be skipped."
        },
        "DeploymentChangesTemplate": {
          "type": "string",
          "description": "A markdown template generated for each deployment's changes."
        },
        "FailTargetDiscovery": {
          "type": "boolean",
          "description": "Option to fail a step if no matching targets found in cloud discovery steps"
        },
        "ForcePackageDownload": {
          "type": "boolean",
          "description": "Option to force re-downloading packages for deployment."
        },
        "GitRef": {
          "type": "string",
          "description": "Git reference to use when modifying deployment settings."
        },
        "ProjectId": {
          "type": "string",
          "description": "The Project ID to get the deployment settings from. Example `Projects-1`.",
          "example": "Projects-1"
        },
        "ReleaseNotesTemplate": {
          "type": "string",
          "description": "Template text pre-filled as the release notes when a release of this project is created; may contain Octopus variable expressions. Omitting this clears the project's existing template."
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        },
        "VersioningStrategy": {
          "$ref": "#/definitions/VersioningStrategyResource"
        }
      },
      "additionalProperties": false
    },
    "ModifyDeploymentTargetCommand": {
      "type": "object",
      "required": [
        "EnvironmentIds",
        "MachineId",
        "Name",
        "Roles",
        "SpaceId"
      ],
      "properties": {
        "Endpoint": {
          "$ref": "#/definitions/EndpointResource"
        },
        "EnvironmentIds": {
          "type": "array",
          "minItems": 1,
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "MachineId": {
          "type": "string",
          "example": "Machines-1"
        },
        "MachinePolicyId": {
          "type": "string",
          "description": "Note: If this is unset, but the endpoint requires a policy, Octopus will update the machine with the _default_ machine policy",
          "example": "MachinePolicies-1"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Roles": {
          "type": "array",
          "minItems": 1,
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantedDeploymentParticipation": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "TenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTags": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Thumbprint": {
          "type": "string"
        },
        "Uri": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ModifyEnvironmentCommand": {
      "type": "object",
      "required": [
        "EnvironmentId",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "AllowDynamicInfrastructure": {
          "type": "boolean"
        },
        "Description": {
          "type": "string"
        },
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "EnvironmentTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ExtensionSettings": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ExtensionSettingsValues"
          }
        },
        "Name": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        },
        "SortOrder": {
          "type": "integer",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "UseGuidedFailure": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "ModifyFeatureToggleCommand": {
      "type": "object",
      "required": [
        "Environments",
        "Id",
        "Name",
        "ProjectId",
        "Slug",
        "SpaceId"
      ],
      "properties": {
        "DefaultIsEnabled": {
          "type": "boolean"
        },
        "Description": {
          "type": "string",
          "maxLength": 1000
        },
        "Environments": {
          "type": "array",
          "description": "The complete set of per-environment configurations for the toggle. This replaces the existing set: environments omitted here are removed from the toggle.",
          "items": {
            "$ref": "#/definitions/ModifyFeatureToggleEnvironment"
          }
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "RolloutGroupId": {
          "type": "string"
        },
        "Slug": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyFeatureToggleEnvironment": {
      "type": "object",
      "required": [
        "DeploymentEnvironmentId",
        "IsEnabled"
      ],
      "properties": {
        "ClientRolloutPercentage": {
          "type": "integer",
          "format": "int32",
          "maximum": 100,
          "minimum": 0
        },
        "DeploymentEnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "ExcludedTenantIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "ExcludedTenantTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "IsEnabled": {
          "type": "boolean"
        },
        "MinimumVersion": {
          "type": "string",
          "description": "A semantic version, for example '2.1.0'. When set, the toggle is only enabled for clients whose application version, reported through the feature toggle SDK, is at or above this version."
        },
        "RolloutPercentage": {
          "type": "integer",
          "format": "int32",
          "maximum": 100,
          "minimum": 0
        },
        "Segments": {
          "type": "array",
          "description": "Key/value targeting rules matched against the evaluation context supplied by the client application through the feature toggle SDK, for example {\"key\": \"region\", \"value\": \"us-east\"}. When set, the toggle is only enabled for clients whose context matches.",
          "maxItems": 100,
          "items": {
            "$ref": "#/definitions/StringStringKeyValuePair"
          }
        },
        "TenantIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyFeedCommand": {
      "type": "object",
      "required": [
        "FeedType",
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "ClientVersion": {
          "$ref": "#/definitions/SemanticVersion"
        },
        "FeedType": {
          "type": "string",
          "description": "The type of the feed.",
          "enum": [
            "None",
            "NuGet",
            "Docker",
            "Maven",
            "OctopusProject",
            "GitHub",
            "Helm",
            "OciRegistry",
            "AwsElasticContainerRegistry",
            "BuiltIn",
            "S3",
            "AzureContainerRegistry",
            "GoogleContainerRegistry",
            "ArtifactoryGeneric",
            "Npm",
            "GcsStorage",
            "PyPi"
          ]
        },
        "Id": {
          "type": "string",
          "description": "The id of the feed.",
          "example": "Feeds-1"
        },
        "Name": {
          "type": "string",
          "description": "The name of the feed.",
          "maxLength": 44,
          "minLength": 0
        },
        "PackageAcquisitionLocationOptions": {
          "type": "array",
          "description": "The feed's package acquisition location options.",
          "items": {
            "type": "string",
            "enum": [
              "Server",
              "ExecutionTarget",
              "NotAcquired"
            ]
          }
        },
        "Slug": {
          "type": "string",
          "description": "The slug of the feed."
        },
        "SpaceId": {
          "type": "string",
          "description": "The id of the space that contains the feed.",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyGitCredentialCommand": {
      "type": "object",
      "required": [
        "Details",
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/ModifyGitCredentialDetails"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "RepositoryRestrictions": {
          "$ref": "#/definitions/GitCredentialRepositoryRestrictionsResource"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyGitCredentialCommandV2": {
      "type": "object",
      "required": [
        "Details",
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/ModifyGitCredentialDetailsV2"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "RepositoryRestrictions": {
          "$ref": "#/definitions/GitCredentialRepositoryRestrictionsResource"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyGitCredentialDetails": {
      "type": "object",
      "required": [
        "Password",
        "Username"
      ],
      "properties": {
        "Password": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "Username": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ModifyGitCredentialDetailsV2": {
      "type": "object",
      "required": [
        "Type"
      ],
      "properties": {
        "Type": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ModifyGitCredentialResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifyGitCredentialResponseV2": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifyGitHubAppConnectionCommand": {
      "type": "object",
      "required": [
        "Id",
        "RepositoryIds",
        "SpaceId"
      ],
      "properties": {
        "Id": {
          "type": "string"
        },
        "RepositoryIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyGitHubAppConnectionResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifyInsightsReportCommand": {
      "type": "object",
      "description": "Updates an existing Insights Report",
      "required": [
        "AllTenants",
        "ChannelIds",
        "EnvironmentGroups",
        "Id",
        "Name",
        "ProjectGroupIds",
        "ProjectIds",
        "SpaceId",
        "TenantIds",
        "TenantMode",
        "TenantTags",
        "TimeZone"
      ],
      "properties": {
        "AllTenants": {
          "type": "boolean",
          "description": "If true, all tenants in the space will be included in the report."
        },
        "ChannelIds": {
          "type": "array",
          "description": "The channels for the report.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Channels-1",
            "..."
          ]
        },
        "Description": {
          "type": "string",
          "description": "The description for the report."
        },
        "EnvironmentGroups": {
          "type": "array",
          "description": "The environment groups for the report.",
          "items": {
            "$ref": "#/definitions/InsightsEnvironmentGroupResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "The Id of the Insights Report",
          "example": "InsightsReports-1"
        },
        "Name": {
          "type": "string",
          "description": "The name of the report.",
          "maxLength": 200,
          "minLength": 1
        },
        "ProjectGroupIds": {
          "type": "array",
          "description": "The project groups for the report.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "ProjectGroups-1",
            "..."
          ]
        },
        "ProjectIds": {
          "type": "array",
          "description": "The projects for the report.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Projects-1",
            "..."
          ]
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        },
        "TenantIds": {
          "type": "array",
          "description": "The tenants for the report.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantMode": {
          "type": "string",
          "description": "The kind of deployments that will be included in this report",
          "enum": [
            "Untenanted",
            "TenantedAndUntenanted",
            "Tenanted"
          ]
        },
        "TenantTags": {
          "type": "array",
          "description": "The tenant tags for the report.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "TimeZone": {
          "type": "string",
          "description": "The timezone of the report."
        }
      },
      "additionalProperties": false
    },
    "ModifyInsightsReportIconCommand": {
      "type": "object",
      "required": [
        "IconColor",
        "IconId",
        "ReportId",
        "SpaceId"
      ],
      "properties": {
        "IconColor": {
          "type": "string",
          "description": "Color of the icon in hex format. Example: '#0D80D8'",
          "minLength": 1,
          "pattern": "^#[0-9a-fA-F]{6}$"
        },
        "IconId": {
          "type": "string",
          "description": "ID of the icon. Example: 'octopus-deploy'",
          "minLength": 1
        },
        "ReportId": {
          "type": "string",
          "description": "The ID of the insights report to change logo for.",
          "example": "InsightsReports-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyInsightsReportIconResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifyInsightsReportResponse": {
      "type": "object",
      "required": [
        "Report"
      ],
      "properties": {
        "Report": {
          "$ref": "#/definitions/InsightsReportResource"
        }
      },
      "additionalProperties": false
    },
    "ModifyLetsEncryptConfigurationCommand": {
      "type": "object",
      "required": [
        "Enabled"
      ],
      "properties": {
        "Enabled": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "ModifyLibraryVariableSetCommand": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "The ID of the library variable set.",
          "example": "LibraryVariableSets-1"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Templates": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          }
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ModifyLifecycleCommand": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "description": "A description of the Lifecycle"
        },
        "Id": {
          "type": "string",
          "description": "The Id of the Lifecycle to modify.",
          "example": "Lifecycles-1"
        },
        "Name": {
          "type": "string",
          "description": "The name of the Lifecycle.",
          "minLength": 1
        },
        "Phases": {
          "type": "array",
          "description": "The complete list of promotion phases in order; existing phases not resubmitted are deleted. Each phase lists environments deployed to automatically (AutomaticDeploymentTargets) or manually (OptionalDeploymentTargets); an environment may appear in only one phase, and at most one phase may list no environments, meaning all remaining environments. MinimumEnvironmentsBeforePromotion is how many of the phase's environments must be deployed before a release can progress (0 means all). IsOptionalPhase allows skipping the phase, but not every phase may be optional. Per-phase retention policies override the lifecycle-level ones.",
          "items": {
            "$ref": "#/definitions/PhaseResource"
          }
        },
        "ReleaseRetentionPolicy": {
          "$ref": "#/definitions/RetentionPeriod"
        },
        "Slug": {
          "type": "string",
          "description": "The slug of the Lifecycle"
        },
        "SpaceId": {
          "type": "string",
          "description": "The id of the Space for the Lifecycle.",
          "example": "Spaces-1"
        },
        "TentacleRetentionPolicy": {
          "$ref": "#/definitions/RetentionPeriod"
        }
      },
      "additionalProperties": false
    },
    "ModifyMachinePolicyCommand": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "ConnectionConnectTimeout": {
          "type": "string",
          "format": "date-span"
        },
        "ConnectionRetryCountLimit": {
          "type": "integer",
          "format": "int32"
        },
        "ConnectionRetrySleepInterval": {
          "type": "string",
          "format": "date-span"
        },
        "ConnectionRetryTimeLimit": {
          "type": "string",
          "format": "date-span"
        },
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "The Machine Policy ID",
          "example": "MachinePolicies-1"
        },
        "IsDefault": {
          "type": "boolean"
        },
        "MachineCleanupPolicy": {
          "$ref": "#/definitions/MachineCleanupPolicyResource"
        },
        "MachineConnectivityPolicy": {
          "$ref": "#/definitions/MachineConnectivityPolicyResource"
        },
        "MachineHealthCheckPolicy": {
          "$ref": "#/definitions/MachineHealthCheckPolicyResource"
        },
        "MachinePackageCacheRetentionPolicy": {
          "$ref": "#/definitions/MachinePackageCacheRetentionPolicyResource"
        },
        "MachineRpcCallRetryPolicy": {
          "$ref": "#/definitions/MachineRpcCallRetryPolicyResource"
        },
        "MachineUpdatePolicy": {
          "$ref": "#/definitions/MachineUpdatePolicyResource"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "PollingRequestQueueTimeout": {
          "type": "string",
          "format": "date-span"
        },
        "SpaceId": {
          "type": "string",
          "description": "The Space ID",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyMaintenanceConfigurationCommand": {
      "type": "object",
      "required": [
        "IsInMaintenanceMode"
      ],
      "properties": {
        "IsInMaintenanceMode": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "ModifyMaintenanceConfigurationResponse": {
      "type": "object",
      "required": [
        "Resource"
      ],
      "properties": {
        "Resource": {
          "$ref": "#/definitions/MaintenanceConfigurationResource"
        }
      },
      "additionalProperties": false
    },
    "ModifyOctopusServerNodeCommand": {
      "type": "object",
      "description": "Modifies an existing Octopus Server node.",
      "required": [
        "Id"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "description": "ID of the OctopusServerNodeResource to modify",
          "example": "OctopusServerNodes-1"
        },
        "IsInMaintenanceMode": {
          "type": "boolean",
          "description": "The updated maintenance mode of the OctopusServerNodeResource to modify"
        },
        "MaxConcurrentTasks": {
          "type": "integer",
          "description": "The updated max concurrent tasks value of the OctopusServerNodeResource to modify",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ModifyOpenTelemetryTraceFileExportConfigurationCommand": {
      "type": "object",
      "required": [
        "Enabled",
        "MaxStorageSizeMegabytes",
        "RetentionDays"
      ],
      "properties": {
        "Enabled": {
          "type": "boolean"
        },
        "MaxStorageSizeMegabytes": {
          "type": "integer",
          "format": "int32"
        },
        "RetentionDays": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ModifyOpenTelemetryTraceFileExportConfigurationResponse": {
      "type": "object",
      "required": [
        "Enabled",
        "MaxStorageSizeMegabytes",
        "RetentionDays"
      ],
      "properties": {
        "Enabled": {
          "type": "boolean"
        },
        "MaxStorageSizeMegabytes": {
          "type": "integer",
          "format": "int32"
        },
        "RetentionDays": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ModifyParentEnvironmentCommand": {
      "type": "object",
      "required": [
        "EnvironmentId",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "AutomaticDeprovisioningRule": {
          "$ref": "#/definitions/AutomaticDeprovisioningRuleResource"
        },
        "Description": {
          "type": "string"
        },
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        },
        "SortOrder": {
          "type": "integer",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "UseGuidedFailure": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "ModifyParentEnvironmentResponse": {
      "type": "object",
      "required": [
        "AutomaticDeprovisioningRule",
        "Id",
        "Name",
        "Slug",
        "SortOrder",
        "SpaceId",
        "UseGuidedFailure"
      ],
      "properties": {
        "AutomaticDeprovisioningRule": {
          "$ref": "#/definitions/AutomaticDeprovisioningRuleResource"
        },
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "example": "Environments-1"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "SortOrder": {
          "type": "integer",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "UseGuidedFailure": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "ModifyPlatformHubAccountCommand": {
      "type": "object",
      "required": [
        "Details",
        "Id",
        "Name"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/AccountDetailsResource"
        },
        "Id": {
          "type": "string",
          "example": "Accounts-1"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ModifyPlatformHubAccountResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifyPlatformHubCertificateCommand": {
      "type": "object",
      "required": [
        "Id",
        "Name"
      ],
      "properties": {
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Notes": {
          "type": "string"
        },
        "Slug": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ModifyPlatformHubFeedCommand": {
      "type": "object",
      "required": [
        "FeedType",
        "Id",
        "Name"
      ],
      "properties": {
        "FeedType": {
          "type": "string",
          "description": "The type of the feed.",
          "enum": [
            "None",
            "NuGet",
            "Docker",
            "Maven",
            "OctopusProject",
            "GitHub",
            "Helm",
            "OciRegistry",
            "AwsElasticContainerRegistry",
            "BuiltIn",
            "S3",
            "AzureContainerRegistry",
            "GoogleContainerRegistry",
            "ArtifactoryGeneric",
            "Npm",
            "GcsStorage",
            "PyPi"
          ]
        },
        "Id": {
          "type": "string",
          "description": "The id of the feed."
        },
        "Name": {
          "type": "string",
          "description": "The name of the feed.",
          "maxLength": 44,
          "minLength": 0
        },
        "PackageAcquisitionLocationOptions": {
          "type": "array",
          "description": "The feed's package acquisition location options.",
          "items": {
            "type": "string",
            "enum": [
              "Server",
              "ExecutionTarget",
              "NotAcquired"
            ]
          }
        },
        "Slug": {
          "type": "string",
          "description": "The slug of the feed."
        }
      },
      "additionalProperties": false
    },
    "ModifyPlatformHubGitCredentialCommand": {
      "type": "object",
      "required": [
        "Details",
        "Id",
        "Name"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/ModifyGitCredentialDetails"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "RepositoryRestrictions": {
          "$ref": "#/definitions/GitCredentialRepositoryRestrictionsResource"
        }
      },
      "additionalProperties": false
    },
    "ModifyPlatformHubGitCredentialCommandV2": {
      "type": "object",
      "required": [
        "Details",
        "Id",
        "Name"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/ModifyPlatformHubGitCredentialDetailsV2"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "RepositoryRestrictions": {
          "$ref": "#/definitions/GitCredentialRepositoryRestrictionsResource"
        }
      },
      "additionalProperties": false
    },
    "ModifyPlatformHubGitCredentialDetailsV2": {
      "type": "object",
      "required": [
        "Type"
      ],
      "properties": {
        "Type": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ModifyPlatformHubGitCredentialResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifyPlatformHubGitCredentialResponseV2": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifyPlatformHubGitHubAppConnectionCommand": {
      "type": "object",
      "required": [
        "Id",
        "RepositoryIds"
      ],
      "properties": {
        "Id": {
          "type": "string"
        },
        "RepositoryIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyPlatformHubGitHubAppConnectionResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifyPlatformHubVersionControlSettingsCommand": {
      "type": "object",
      "required": [
        "BasePath",
        "Credentials",
        "DefaultBranch",
        "Url"
      ],
      "properties": {
        "BasePath": {
          "type": "string"
        },
        "Credentials": {
          "$ref": "#/definitions/GitCredentialUsageResource"
        },
        "DefaultBranch": {
          "type": "string"
        },
        "Url": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ModifyProcessTemplateCommand": {
      "type": "object",
      "required": [
        "GitRef",
        "Name",
        "Parameters",
        "Slug",
        "Steps"
      ],
      "properties": {
        "ChangeDescription": {
          "type": "string"
        },
        "Description": {
          "type": "string"
        },
        "GitRef": {
          "type": "string"
        },
        "Icon": {
          "$ref": "#/definitions/IconResource"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Parameters": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ProcessTemplateParameterResource"
          }
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "Steps": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentStepResource"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyProjectCommand": {
      "type": "object",
      "required": [
        "LifecycleId",
        "Name",
        "ProjectGroupId",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "AllowIgnoreChannelRules": {
          "type": "boolean"
        },
        "AutoCreateRelease": {
          "type": "boolean"
        },
        "AutoDeployReleaseOverrides": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/AutoDeployReleaseOverrideResource"
          }
        },
        "ChangeDescription": {
          "type": "string",
          "description": "The change description"
        },
        "ClonedFromProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "CombineHealthAndSyncStatusInDashboardLiveStatus": {
          "type": "boolean"
        },
        "DefaultGuidedFailureMode": {
          "type": "string",
          "enum": [
            "EnvironmentDefault",
            "Off",
            "On"
          ]
        },
        "DefaultPowerShellEdition": {
          "type": "string",
          "description": "Which edition of PowerShell the project's script steps run under: \"Desktop\" (Windows PowerShell) or \"Core\" (cross-platform PowerShell). Leave unset to inherit the server default."
        },
        "DefaultToSkipIfAlreadyInstalled": {
          "type": "boolean"
        },
        "DeploymentChangesTemplate": {
          "type": "string"
        },
        "DeprovisioningRunbookId": {
          "type": "string",
          "description": "ID of a runbook in this project that tears down an ephemeral environment. Must be an existing runbook of this project; call find_runbooks to look one up. Only relevant to projects using ephemeral environments.",
          "example": "Runbooks-1"
        },
        "Description": {
          "type": "string"
        },
        "DiscreteChannelRelease": {
          "type": "boolean",
          "description": "Treats releases of different channels to the same environment as a separate deployment dimension. 'False' indicates a \"hotfix\"-style usage of channels (single release active per environment ignoring channels), whereas `True` indicates \"microservice\"-style usage (single release per environment per channel)"
        },
        "ExecuteDeploymentsOnEventBasedPipeline": {
          "type": "boolean"
        },
        "ExtensionSettings": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ExtensionSettingsValues"
          }
        },
        "ForcePackageDownload": {
          "type": "boolean"
        },
        "IncludedLibraryVariableSetIds": {
          "type": "array",
          "description": "Library variable sets included in the project. Sets are listed in order of precedence, with earlier items in the list overriding any variables with the same name and scope definition appearing later in the list.",
          "items": {
            "type": "string"
          }
        },
        "IsBadgesEnabled": {
          "type": "boolean"
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "LifecycleId": {
          "type": "string",
          "example": "Lifecycles-1"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "PersistenceSettings": {
          "$ref": "#/definitions/PersistenceSettingsResource"
        },
        "ProjectConnectivityPolicy": {
          "$ref": "#/definitions/DeploymentConnectivityPolicy"
        },
        "ProjectGroupId": {
          "type": "string",
          "example": "ProjectGroups-1"
        },
        "ProjectId": {
          "type": "string",
          "description": "ID of the project to modify",
          "example": "Projects-1"
        },
        "ProjectTags": {
          "type": "array",
          "description": "The project's complete set of tags, each written as \"TagSet/Tag\" using either the names or the IDs of the tag set and tag (for example \"Regions/us-east\"). This replaces the project's current tags, so resubmit the existing ones you want to keep. Call find_tag_sets to discover which tag sets apply to projects.",
          "items": {
            "type": "string"
          }
        },
        "ProvisioningRunbookId": {
          "type": "string",
          "description": "ID of a runbook in this project that provisions an ephemeral environment. Must be an existing runbook of this project; call find_runbooks to look one up. Only relevant to projects using ephemeral environments.",
          "example": "Runbooks-1"
        },
        "ReleaseCreationStrategy": {
          "$ref": "#/definitions/ReleaseCreationStrategyResource"
        },
        "ReleaseNotesTemplate": {
          "type": "string"
        },
        "Slug": {
          "type": "string",
          "description": "URL-friendly short identifier for the project, unique within the space. Leave unset to keep the project's current slug."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Templates": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          }
        },
        "TenantedDeploymentMode": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "VersioningStrategy": {
          "$ref": "#/definitions/VersioningStrategyResource"
        }
      },
      "additionalProperties": false
    },
    "ModifyProjectGroupCommand": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "description": "The description of the project group"
        },
        "Id": {
          "type": "string",
          "description": "The ID of the project group.",
          "example": "ProjectGroups-1"
        },
        "Name": {
          "type": "string",
          "description": "The name of the project group.",
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyProjectIconCommand": {
      "type": "object",
      "required": [
        "IconColor",
        "IconId",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "IconColor": {
          "type": "string",
          "description": "Color of the icon in hex format. Example: '#0D80D8'",
          "minLength": 1,
          "pattern": "^#[0-9a-fA-F]{6}$"
        },
        "IconId": {
          "type": "string",
          "description": "ID of the icon. Example: 'octopus-deploy'",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "description": "The ID of the project to change logo for. Example: 'Projects-1'",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyProjectIconResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifyProjectTriggerCommand": {
      "type": "object",
      "description": "Updates an existing project trigger",
      "required": [
        "Id",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "Action": {
          "$ref": "#/definitions/TriggerActionResource"
        },
        "Description": {
          "type": "string",
          "description": "Description for the project trigger"
        },
        "Filter": {
          "$ref": "#/definitions/TriggerFilterResource"
        },
        "Id": {
          "type": "string",
          "description": "Id of the project trigger",
          "example": "ProjectTriggers-1"
        },
        "IsDisabled": {
          "type": "boolean",
          "description": "Disables the trigger from being run when set"
        },
        "Name": {
          "type": "string",
          "description": "Name of the project trigger"
        },
        "ProjectId": {
          "type": "string",
          "description": "ProjectId of the project trigger",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "Id of the space where the project is located",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyProjectVariablesByTenantIdCommand": {
      "type": "object",
      "required": [
        "SpaceId",
        "TenantId",
        "Variables"
      ],
      "properties": {
        "ConcurrencyToken": {
          "type": "string",
          "description": "The concurrency token returned when reading the tenant's variables. Always pass it back so the write is rejected if someone else changed the variables since your read; omitting it skips the check and risks silently overwriting their changes."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        },
        "Variables": {
          "type": "array",
          "description": "The complete set of project variable values for the tenant; existing values omitted here are deleted. Each item is an object: 'Id' (the existing value's ID when updating; omit when adding), 'OwnerId' (the project ID), 'TemplateId' (the variable template ID), 'Value' (a plain string for non-sensitive values, or {\"HasValue\": true, \"NewValue\": \"secret\"} for sensitive ones), and 'Scope' ({\"EnvironmentIds\": [...]} limiting the value to those environments; empty applies to all).",
          "items": {
            "$ref": "#/definitions/TenantProjectVariablePayload"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyProjectVariablesByTenantIdResponse": {
      "type": "object",
      "required": [
        "ConcurrencyToken",
        "TenantId",
        "Variables"
      ],
      "properties": {
        "ConcurrencyToken": {
          "type": "string",
          "minLength": 1
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        },
        "Variables": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TenantProjectVariableV2"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyProjectVariableSetInDatabaseCommand": {
      "type": "object",
      "required": [
        "ProjectId",
        "ScopeValues",
        "SpaceId",
        "Variables"
      ],
      "properties": {
        "ChangeDescription": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ScopeValues": {
          "$ref": "#/definitions/VariableScopeValues"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        },
        "Variables": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/VariableResource"
          }
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ModifyProjectVariableSetInDatabaseResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifyProjectVariableSetInGitCommand": {
      "type": "object",
      "required": [
        "GitRef",
        "ProjectId",
        "ScopeValues",
        "SpaceId",
        "Variables"
      ],
      "properties": {
        "ChangeDescription": {
          "type": "string"
        },
        "GitRef": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ScopeValues": {
          "$ref": "#/definitions/VariableScopeValues"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        },
        "Variables": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/VariableResource"
          }
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ModifyProjectVariableSetInGitResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifyProxyCommand": {
      "type": "object",
      "required": [
        "Host",
        "Id",
        "Name",
        "Port",
        "SpaceId"
      ],
      "properties": {
        "Host": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string",
          "description": "ID of the Proxy to modify",
          "example": "Proxys-1"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Password": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "Port": {
          "type": "integer",
          "format": "int32",
          "maximum": 65535,
          "minimum": 0
        },
        "ProxyType": {
          "type": "string",
          "description": "The type of proxy. Currently only HTTP is supported."
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the Space containing the Proxy to modify.",
          "example": "Spaces-1"
        },
        "Username": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ModifyRateLimitingPolicyCommand": {
      "type": "object",
      "required": [
        "AuditMode",
        "BurstLimit",
        "Id",
        "IsEnabled",
        "Name",
        "RequestsPerMinute",
        "ScopeType"
      ],
      "properties": {
        "AuditMode": {
          "type": "boolean",
          "description": "When enabled, the policy logs requests that would be rate limited without rejecting them (no 429 response)."
        },
        "BurstLimit": {
          "type": "integer",
          "description": "Maximum capacity of the token bucket.",
          "format": "int32",
          "example": 200
        },
        "Id": {
          "type": "string",
          "description": "ID of the policy to modify.",
          "example": "RateLimitingPolicies-1"
        },
        "IsEnabled": {
          "type": "boolean",
          "description": "Whether this policy is actively enforced."
        },
        "Name": {
          "type": "string",
          "description": "The display name of the policy.",
          "minLength": 1,
          "example": "Authenticated requests"
        },
        "RequestsPerMinute": {
          "type": "integer",
          "description": "Number of requests permitted per minute.",
          "format": "int32",
          "example": 600
        },
        "ScopeType": {
          "type": "string",
          "description": "The scope this policy applies to."
        }
      },
      "additionalProperties": false
    },
    "ModifyReleaseCommand": {
      "type": "object",
      "required": [
        "ChannelId",
        "Id",
        "ProjectId",
        "SpaceId",
        "Version"
      ],
      "properties": {
        "ChannelId": {
          "type": "string",
          "example": "Channels-1"
        },
        "CustomFields": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Id": {
          "type": "string",
          "description": "ID of the Release.",
          "example": "Releases-1"
        },
        "IgnoreChannelRules": {
          "type": "boolean",
          "description": "If altering the Channel of an existing Release, its rules may be violated. This ignores those violations. If not altering the Release Channel, this parameter is ignored."
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ReleaseNotes": {
          "type": "string"
        },
        "SelectedGitResources": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SelectedGitResource"
          }
        },
        "SelectedPackages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SelectedPackage"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Version": {
          "type": "string",
          "maxLength": 349,
          "minLength": 0
        }
      },
      "additionalProperties": false
    },
    "ModifyRetentionDefaultConfigurationCommand": {
      "type": "object",
      "properties": {
        "RetentionDays": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ModifyRolloutGroupCommand": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyRunbookInDatabaseCommand": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "ProjectId",
        "RunRetentionPolicy",
        "SpaceId"
      ],
      "properties": {
        "CancelQueuedTasks": {
          "type": "boolean",
          "description": "When a new run of this runbook is queued, automatically cancel earlier runs of it that are still queued and now superseded. This is a standing setting on the runbook, not an instruction to cancel anything right now. Omit to leave the current setting unchanged."
        },
        "CancelRunningTasks": {
          "type": "boolean",
          "description": "When a new run of this runbook is queued, automatically cancel an earlier run of it that is already executing and now superseded. This is a standing setting on the runbook, not an instruction to cancel anything right now. Omit to leave the current setting unchanged."
        },
        "ConnectivityPolicy": {
          "$ref": "#/definitions/DeploymentConnectivityPolicy"
        },
        "DefaultGuidedFailureMode": {
          "type": "string",
          "description": "What a run does when a step fails. One of 'EnvironmentDefault' (follow the target environment's setting), 'Off' (fail the run immediately), or 'On' (pause the run and wait for someone to choose whether to retry, ignore or abort). Resets to 'Off' when omitted.",
          "enum": [
            "EnvironmentDefault",
            "Off",
            "On"
          ]
        },
        "Description": {
          "type": "string"
        },
        "Environments": {
          "type": "array",
          "description": "The runbook's complete environment list, used when EnvironmentScope is 'Specified'. This replaces the current list, so resubmit the existing environments you want to keep. The update is rejected if it would remove an environment that a project trigger still runs this runbook in.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "EnvironmentScope": {
          "type": "string",
          "description": "Which environments the runbook may be run in. One of 'All' (every environment in the space), 'Specified' (only the environments listed in Environments), or 'FromProjectLifecycles' (only the environments used by the project's lifecycles). Resets to 'All' when omitted.",
          "enum": [
            "All",
            "Specified",
            "FromProjectLifecycles"
          ]
        },
        "FailTargetDiscovery": {
          "type": "boolean",
          "description": "Fail a run when one of its target discovery steps finds no matching deployment targets, instead of letting the step succeed. Resets to false when omitted."
        },
        "ForcePackageDownload": {
          "type": "boolean",
          "description": "Re-download every package on each run instead of reusing the copy already cached on the deployment target. Resets to false when omitted."
        },
        "Id": {
          "type": "string",
          "description": "The ID of the runbook to update, for example 'Runbooks-123'.",
          "example": "Runbooks-1"
        },
        "MultiTenancyMode": {
          "type": "string",
          "description": "Whether the runbook can be run for tenants. One of 'Untenanted' (untenanted runs only), 'Tenanted' (a tenant must be supplied for every run), or 'TenantedOrUntenanted' (either is allowed). Resets to 'Untenanted' when omitted.",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "description": "The ID of the project the runbook belongs to. Must be a project that stores its runbooks in the Octopus database.",
          "example": "Projects-1"
        },
        "PublishedRunbookSnapshotId": {
          "type": "string",
          "description": "The ID of the runbook snapshot to publish. Setting this to a different snapshot publishes that snapshot, which is what subsequent runs execute. Resubmit the current value to leave the published snapshot alone."
        },
        "RunbookProcessId": {
          "type": "string",
          "description": "Leave this as the value returned by get_runbook. Octopus manages the link between a runbook and its process."
        },
        "RunbookTags": {
          "type": "array",
          "description": "The runbook's complete set of tags, each written as \"TagSet/Tag\" using either the names or the IDs of the tag set and tag (for example \"Ops/Nightly\"). This replaces the current tags, so resubmit the existing ones you want to keep. Call find_tag_sets to discover which tag sets apply to runbooks.",
          "items": {
            "type": "string"
          }
        },
        "RunRetentionPolicy": {
          "$ref": "#/definitions/RunbookRetentionPolicy"
        },
        "Slug": {
          "type": "string",
          "description": "A short URL-friendly identifier for the runbook, unique within the project. The current slug is kept when omitted."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyRunbookInGitCommand": {
      "type": "object",
      "required": [
        "GitRef",
        "Id",
        "Name",
        "ProjectId",
        "RunRetentionPolicy",
        "SpaceId"
      ],
      "properties": {
        "CancelQueuedTasks": {
          "type": "boolean",
          "description": "When a new run of this runbook is queued, automatically cancel earlier runs of it that are still queued and now superseded. This is a standing setting on the runbook, not an instruction to cancel anything right now. Omit to leave the current setting unchanged."
        },
        "CancelRunningTasks": {
          "type": "boolean",
          "description": "When a new run of this runbook is queued, automatically cancel an earlier run of it that is already executing and now superseded. This is a standing setting on the runbook, not an instruction to cancel anything right now. Omit to leave the current setting unchanged."
        },
        "ChangeDescription": {
          "type": "string",
          "description": "The commit message for the change. Defaults to 'Update runbook' when omitted."
        },
        "ConnectivityPolicy": {
          "$ref": "#/definitions/DeploymentConnectivityPolicy"
        },
        "DefaultGuidedFailureMode": {
          "type": "string",
          "description": "What a run does when a step fails. One of 'EnvironmentDefault' (follow the target environment's setting), 'Off' (fail the run immediately), or 'On' (pause the run and wait for someone to choose whether to retry, ignore or abort). Resets to 'Off' when omitted.",
          "enum": [
            "EnvironmentDefault",
            "Off",
            "On"
          ]
        },
        "Description": {
          "type": "string"
        },
        "Environments": {
          "type": "array",
          "description": "The runbook's complete environment list, used when EnvironmentScope is 'Specified'. This replaces the current list, so resubmit the existing environments you want to keep. The update is rejected if it would remove an environment that a project trigger still runs this runbook in.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "EnvironmentScope": {
          "type": "string",
          "description": "Which environments the runbook may be run in. One of 'All' (every environment in the space), 'Specified' (only the environments listed in Environments), or 'FromProjectLifecycles' (only the environments used by the project's lifecycles). Resets to 'All' when omitted.",
          "enum": [
            "All",
            "Specified",
            "FromProjectLifecycles"
          ]
        },
        "FailTargetDiscovery": {
          "type": "boolean",
          "description": "Fail a run when one of its target discovery steps finds no matching deployment targets, instead of letting the step succeed. Resets to false when omitted."
        },
        "ForcePackageDownload": {
          "type": "boolean",
          "description": "Re-download every package on each run instead of reusing the copy already cached on the deployment target. Resets to false when omitted."
        },
        "GitRef": {
          "type": "string",
          "description": "The Git branch to commit the change to. This must be a branch — a tag or commit cannot be written to — and the branch must not be protected in the project's version control settings. Use get_branches to list the project's branches."
        },
        "Id": {
          "type": "string",
          "description": "The ID of the runbook to update. A runbook stored in Git uses its slug as the ID, which is only unique within its project and Git ref.",
          "example": "Runbooks-1"
        },
        "MultiTenancyMode": {
          "type": "string",
          "description": "Whether the runbook can be run for tenants. One of 'Untenanted' (untenanted runs only), 'Tenanted' (a tenant must be supplied for every run), or 'TenantedOrUntenanted' (either is allowed). Resets to 'Untenanted' when omitted.",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "description": "The ID of the project the runbook belongs to. Must be a version-controlled project that stores its runbooks in Git.",
          "example": "Projects-1"
        },
        "PublishedRunbookSnapshotId": {
          "type": "string",
          "description": "The ID of the runbook snapshot to publish. Resubmit the current value to leave the published snapshot alone."
        },
        "RunbookProcessId": {
          "type": "string",
          "description": "Leave this as the value returned by get_runbook. Octopus manages the link between a runbook and its process."
        },
        "RunbookTags": {
          "type": "array",
          "description": "The runbook's complete set of tags, each written as \"TagSet/Tag\" using either the names or the IDs of the tag set and tag (for example \"Ops/Nightly\"). This replaces the current tags, so resubmit the existing ones you want to keep. Call find_tag_sets to discover which tag sets apply to runbooks.",
          "items": {
            "type": "string"
          }
        },
        "RunRetentionPolicy": {
          "$ref": "#/definitions/RunbookRetentionPolicy"
        },
        "Slug": {
          "type": "string",
          "description": "A short URL-friendly identifier for the runbook, unique within the project. The current slug is kept when omitted."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyRunbookProcessInDatabaseCommand": {
      "type": "object",
      "description": "Only allowed for Runbook Processes owned by a project.",
      "required": [
        "Version"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastSnapshotId": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "RunbookId": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Steps": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentStepResource"
          },
          "readOnly": true
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ModifyRunbookProcessInGitCommand": {
      "type": "object",
      "description": "Only allowed for Runbook Processes owned by a project.",
      "required": [
        "GitRef",
        "Version"
      ],
      "properties": {
        "ChangeDescription": {
          "type": "string",
          "description": "The commit message for updating the Git repository"
        },
        "GitRef": {
          "type": "string",
          "description": "The GitRef containing the resource(s)"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastSnapshotId": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "RunbookId": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Steps": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentStepResource"
          },
          "readOnly": true
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ModifyRunbookSnapshotCommand": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "description": "ID of the runbook snapshot to modify."
        },
        "Name": {
          "type": "string",
          "description": "The name of the runbook snapshot.",
          "minLength": 1
        },
        "Notes": {
          "type": "string",
          "description": "Any additional information about the runbook snapshot."
        },
        "ProjectId": {
          "type": "string",
          "description": "Not used to locate the snapshot; the snapshot ID alone finds it. Safe to omit.",
          "example": "Projects-1"
        },
        "SelectedGitResources": {
          "type": "array",
          "description": "The git resources and versions used in the runbook snapshot.",
          "items": {
            "$ref": "#/definitions/SelectedGitResource"
          }
        },
        "SelectedPackages": {
          "type": "array",
          "description": "The packages and versions used in the runbook snapshot.",
          "items": {
            "$ref": "#/definitions/SelectedPackage"
          }
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyScopedUserRoleCommand": {
      "type": "object",
      "required": [
        "Id",
        "TeamId",
        "UserRoleId"
      ],
      "properties": {
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Id": {
          "type": "string",
          "description": "The ID of the scoped user role to modify.",
          "minLength": 1
        },
        "ProjectGroupIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "ProjectGroups-1",
            "..."
          ]
        },
        "ProjectIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Projects-1",
            "..."
          ]
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TeamId": {
          "type": "string",
          "minLength": 1
        },
        "TenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "UserRoleId": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ModifyServerTaskStateCommand": {
      "type": "object",
      "required": [
        "Id",
        "Reason",
        "State"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "description": "The ID of the task",
          "example": "ServerTasks-1"
        },
        "Reason": {
          "type": "string",
          "description": "The reason for the state change",
          "minLength": 1
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        },
        "State": {
          "type": "string",
          "description": "The state to set the task to",
          "enum": [
            "Queued",
            "Executing",
            "Failed",
            "Canceled",
            "TimedOut",
            "Success",
            "Cancelling"
          ]
        }
      },
      "additionalProperties": false
    },
    "ModifyServiceAccountOidcIdentityCommandV1": {
      "type": "object",
      "required": [
        "Id",
        "Issuer",
        "Name",
        "ServiceAccountId",
        "Subject"
      ],
      "properties": {
        "Audience": {
          "type": "string",
          "description": "The audience of tokens for the OIDC identity"
        },
        "Id": {
          "type": "string",
          "description": "The id of the ServiceAccountOidcIdentity."
        },
        "Issuer": {
          "type": "string",
          "description": "The issuer of tokens for the OIDC identity",
          "maxLength": 200,
          "minLength": 1
        },
        "Name": {
          "type": "string",
          "description": "The name of the ServiceAccountOidcIdentity.",
          "maxLength": 200,
          "minLength": 1
        },
        "ServiceAccountId": {
          "type": "string",
          "description": "The id of the space for the ServiceAccountOidcIdentity.",
          "example": "Users-1"
        },
        "Subject": {
          "type": "string",
          "description": "The name of the ServiceAccountOidcIdentity.",
          "maxLength": 200,
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ModifyServiceAccountOidcIdentityResponseV1": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifySmtpConfigurationCommand": {
      "type": "object",
      "properties": {
        "Details": {
          "$ref": "#/definitions/SmtpCredentialDetailsResource"
        },
        "EnableSsl": {
          "type": "boolean"
        },
        "SendEmailFrom": {
          "type": "string"
        },
        "SmtpHost": {
          "type": "string"
        },
        "SmtpPort": {
          "type": "integer",
          "format": "int32",
          "maximum": 65535,
          "minimum": 0
        },
        "Timeout": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ModifySpaceCommandV1": {
      "type": "object",
      "required": [
        "Id",
        "IsDefault",
        "Name",
        "SpaceManagersTeamMembers",
        "SpaceManagersTeams",
        "TaskQueueStopped"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "example": "Spaces-1"
        },
        "IsDefault": {
          "type": "boolean"
        },
        "Name": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1
        },
        "Slug": {
          "type": "string",
          "maxLength": 50
        },
        "SpaceManagersTeamMembers": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Users-1",
            "..."
          ]
        },
        "SpaceManagersTeams": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "TaskQueueStopped": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "ModifySpaceIconCommand": {
      "type": "object",
      "required": [
        "IconColor",
        "IconId",
        "SpaceId"
      ],
      "properties": {
        "IconColor": {
          "type": "string",
          "description": "Color of the icon in hex format. Example: '#0D80D8'",
          "minLength": 1,
          "pattern": "^#[0-9a-fA-F]{6}$"
        },
        "IconId": {
          "type": "string",
          "description": "ID of the icon. Example: 'octopus-deploy'",
          "minLength": 1
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the Space to change logo for. Example: 'Space-1'",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifySpaceIconResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifySubscriptionCommand": {
      "type": "object",
      "required": [
        "EventNotificationSubscription",
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "EventNotificationSubscription": {
          "$ref": "#/definitions/EventNotificationSubscriptionResource"
        },
        "Id": {
          "type": "string",
          "description": "ID of the Subscription to modify",
          "example": "Subscriptions-1"
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource.",
          "example": "Spaces-1"
        },
        "Type": {
          "type": "string",
          "enum": [
            "Event"
          ]
        }
      },
      "additionalProperties": false
    },
    "ModifyTagSetCommand": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "description": "Sets the description of this tag set."
        },
        "Id": {
          "type": "string",
          "description": "ID of the Tag Set to modify",
          "example": "TagSets-1"
        },
        "Name": {
          "type": "string",
          "description": "Sets the name of this tag set.",
          "minLength": 1
        },
        "Scopes": {
          "type": "array",
          "description": "The complete set of resource types the tag set applies to; a scope omitted here is removed (rejected if tags are in use for it). Valid values: 'Tenant', 'Environment', 'Project', 'Target', 'Runbook', 'Feature Toggle'. Defaults to ['Tenant'] when omitted.",
          "items": {
            "type": "string"
          }
        },
        "SortOrder": {
          "type": "integer",
          "description": "Sets the sort order of this tag set.",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Tags": {
          "type": "array",
          "description": "The complete list of tags for the tag set; existing tags omitted here are deleted (rejected if still in use). Each tag is an object with a 'Name', an optional 'Description', a 'Color' hex code (e.g. '#3156B3'), a 'SortOrder', and — for existing tags — the 'Id' from get_tag_set, which must be kept to update or rename a tag rather than replace it.",
          "items": {
            "$ref": "#/definitions/TagResource"
          }
        },
        "Type": {
          "type": "string",
          "description": "How tags from the set are applied to a resource: 'MultiSelect' (any number of tags), 'SingleSelect' (one tag at a time), or 'FreeText' (arbitrary values, no predefined tags). Defaults to 'MultiSelect' when omitted; a tag set in use can only change from SingleSelect to MultiSelect."
        }
      },
      "additionalProperties": false
    },
    "ModifyTeamCommand": {
      "type": "object",
      "description": "The Everyone Team is treated as a special case and its members and external groups may not be changed.",
      "required": [
        "Id",
        "Name"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "ExternalSecurityGroups": {
          "type": "array",
          "description": "The externally-managed security groups (e.g., Active Directory groups) who belong to the team.",
          "items": {
            "$ref": "#/definitions/NamedReferenceItem"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource.",
          "example": "Teams-1"
        },
        "MemberUserIds": {
          "type": "array",
          "description": "The users who belong to the team.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Users-1",
            "..."
          ]
        },
        "Name": {
          "type": "string",
          "description": "Gets or sets the name of this team.",
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyTelemetryConfigurationCommand": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsTelemetryEnforced": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ShowAsNewUntil": {
          "type": "string",
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "ModifyTenantCommand": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "ID of the Tenant to modify.",
          "example": "Tenants-1"
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectEnvironments": {
          "type": "object",
          "description": "The complete set of projects the tenant is connected to, as an object keyed by project ID where each value is the array of environment IDs the tenant can deploy to for that project. Example: {\"Projects-1\": [\"Environments-1\"]}. Replaces the tenant's current connections; omitting an existing project disconnects it and deletes the tenant's variable values for it.",
          "additionalProperties": {
            "type": "array",
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          }
        },
        "Slug": {
          "type": "string",
          "description": "A URL-friendly, unique identifier for the tenant. Resubmit the tenant's current slug unless you intend to change it; changing it breaks existing links that use the old slug."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantTags": {
          "type": "array",
          "description": "The complete set of tags for the tenant, as canonical tag names in the form 'TagSetName/TagName'. Example: [\"Regions/EU-West\", \"Tier/Premium\"]. Replaces the tenant's current tags; any existing tag omitted here is removed.",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyTenantIconCommand": {
      "type": "object",
      "required": [
        "IconColor",
        "IconId",
        "SpaceId",
        "TenantId"
      ],
      "properties": {
        "IconColor": {
          "type": "string",
          "description": "Color of the icon in hex format. Example: '#0D80D8'",
          "minLength": 1,
          "pattern": "^#[0-9a-fA-F]{6}$"
        },
        "IconId": {
          "type": "string",
          "description": "ID of the icon. Example: 'octopus-deploy'",
          "minLength": 1
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        },
        "TenantId": {
          "type": "string",
          "description": "The ID of the tenant to change logo for. Example: 'Tenants-1'",
          "example": "Tenants-1"
        }
      },
      "additionalProperties": false
    },
    "ModifyTenantIconResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "ModifyUserCommand": {
      "type": "object",
      "required": [
        "DisplayName",
        "Id",
        "IsActive",
        "Username"
      ],
      "properties": {
        "DisplayName": {
          "type": "string",
          "minLength": 1
        },
        "EmailAddress": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "example": "Users-1"
        },
        "Identities": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/IdentityResource"
          }
        },
        "IsActive": {
          "type": "boolean"
        },
        "Password": {
          "type": "string"
        },
        "Username": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ModifyUserRoleCommand": {
      "type": "object",
      "required": [
        "Id"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "GrantedSpacePermissions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "AdministerSystem",
              "ProjectEdit",
              "ProjectView",
              "ProjectCreate",
              "ProjectDelete",
              "ProcessView",
              "ProcessEdit",
              "VariableEdit",
              "VariableEditUnscoped",
              "VariableView",
              "VariableViewUnscoped",
              "ReleaseCreate",
              "ReleaseView",
              "ReleaseEdit",
              "ReleaseDelete",
              "DefectReport",
              "DefectResolve",
              "DeploymentCreate",
              "DeploymentDelete",
              "DeploymentView",
              "EnvironmentView",
              "EnvironmentCreate",
              "EnvironmentEdit",
              "EnvironmentDelete",
              "MachineCreate",
              "MachineEdit",
              "MachineView",
              "MachineDelete",
              "ArtifactView",
              "ArtifactCreate",
              "ArtifactEdit",
              "ArtifactDelete",
              "FeedView",
              "EventView",
              "LibraryVariableSetView",
              "LibraryVariableSetCreate",
              "LibraryVariableSetEdit",
              "LibraryVariableSetDelete",
              "ProjectGroupView",
              "ProjectGroupCreate",
              "ProjectGroupEdit",
              "ProjectGroupDelete",
              "TeamCreate",
              "TeamView",
              "TeamEdit",
              "TeamDelete",
              "UserView",
              "UserInvite",
              "UserRoleView",
              "UserRoleEdit",
              "TaskView",
              "TaskCreate",
              "TaskCancel",
              "TaskEdit",
              "TaskPrioritize",
              "InterruptionView",
              "InterruptionSubmit",
              "InterruptionViewSubmitResponsible",
              "BuiltInFeedPush",
              "BuiltInFeedAdminister",
              "BuiltInFeedDownload",
              "ActionTemplateView",
              "ActionTemplateCreate",
              "ActionTemplateEdit",
              "ActionTemplateDelete",
              "LifecycleCreate",
              "LifecycleView",
              "LifecycleEdit",
              "LifecycleDelete",
              "AccountView",
              "AccountEdit",
              "AccountCreate",
              "AccountDelete",
              "TenantCreate",
              "TenantEdit",
              "TenantView",
              "TenantDelete",
              "TagSetCreate",
              "TagSetEdit",
              "TagSetDelete",
              "TelemetryView",
              "MachinePolicyCreate",
              "MachinePolicyView",
              "MachinePolicyEdit",
              "MachinePolicyDelete",
              "ProxyCreate",
              "ProxyView",
              "ProxyEdit",
              "ProxyDelete",
              "SubscriptionCreate",
              "SubscriptionView",
              "SubscriptionEdit",
              "SubscriptionDelete",
              "TriggerCreate",
              "TriggerView",
              "TriggerEdit",
              "TriggerDelete",
              "CertificateView",
              "CertificateCreate",
              "CertificateEdit",
              "CertificateDelete",
              "CertificateExportPrivateKey",
              "UserEdit",
              "ConfigureServer",
              "FeedEdit",
              "WorkerView",
              "WorkerEdit",
              "SpaceEdit",
              "SpaceView",
              "SpaceDelete",
              "SpaceCreate",
              "BuildInformationPush",
              "BuildInformationAdminister",
              "RunbookView",
              "RunbookEdit",
              "RunbookSnapshotCreate",
              "RunbookRunView",
              "RunbookRunDelete",
              "RunbookRunCreate",
              "GitCredentialView",
              "GitCredentialEdit",
              "EventRetentionDelete",
              "EventRetentionView",
              "InsightsReportView",
              "InsightsReportCreate",
              "InsightsReportEdit",
              "InsightsReportDelete",
              "DeploymentFreezeAdminister",
              "TargetTagView",
              "TargetTagAdminister",
              "PlatformHubView",
              "PlatformHubEdit",
              "RetentionAdminister",
              "FeatureToggleEdit",
              "ApprovalPolicyAdminister",
              "SshKnownHostsAdminister",
              "SshKnownHostsView",
              "AiAgentTranscriptView",
              "DeployedResourceAdminister"
            ]
          }
        },
        "GrantedSystemPermissions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "AdministerSystem",
              "ProjectEdit",
              "ProjectView",
              "ProjectCreate",
              "ProjectDelete",
              "ProcessView",
              "ProcessEdit",
              "VariableEdit",
              "VariableEditUnscoped",
              "VariableView",
              "VariableViewUnscoped",
              "ReleaseCreate",
              "ReleaseView",
              "ReleaseEdit",
              "ReleaseDelete",
              "DefectReport",
              "DefectResolve",
              "DeploymentCreate",
              "DeploymentDelete",
              "DeploymentView",
              "EnvironmentView",
              "EnvironmentCreate",
              "EnvironmentEdit",
              "EnvironmentDelete",
              "MachineCreate",
              "MachineEdit",
              "MachineView",
              "MachineDelete",
              "ArtifactView",
              "ArtifactCreate",
              "ArtifactEdit",
              "ArtifactDelete",
              "FeedView",
              "EventView",
              "LibraryVariableSetView",
              "LibraryVariableSetCreate",
              "LibraryVariableSetEdit",
              "LibraryVariableSetDelete",
              "ProjectGroupView",
              "ProjectGroupCreate",
              "ProjectGroupEdit",
              "ProjectGroupDelete",
              "TeamCreate",
              "TeamView",
              "TeamEdit",
              "TeamDelete",
              "UserView",
              "UserInvite",
              "UserRoleView",
              "UserRoleEdit",
              "TaskView",
              "TaskCreate",
              "TaskCancel",
              "TaskEdit",
              "TaskPrioritize",
              "InterruptionView",
              "InterruptionSubmit",
              "InterruptionViewSubmitResponsible",
              "BuiltInFeedPush",
              "BuiltInFeedAdminister",
              "BuiltInFeedDownload",
              "ActionTemplateView",
              "ActionTemplateCreate",
              "ActionTemplateEdit",
              "ActionTemplateDelete",
              "LifecycleCreate",
              "LifecycleView",
              "LifecycleEdit",
              "LifecycleDelete",
              "AccountView",
              "AccountEdit",
              "AccountCreate",
              "AccountDelete",
              "TenantCreate",
              "TenantEdit",
              "TenantView",
              "TenantDelete",
              "TagSetCreate",
              "TagSetEdit",
              "TagSetDelete",
              "TelemetryView",
              "MachinePolicyCreate",
              "MachinePolicyView",
              "MachinePolicyEdit",
              "MachinePolicyDelete",
              "ProxyCreate",
              "ProxyView",
              "ProxyEdit",
              "ProxyDelete",
              "SubscriptionCreate",
              "SubscriptionView",
              "SubscriptionEdit",
              "SubscriptionDelete",
              "TriggerCreate",
              "TriggerView",
              "TriggerEdit",
              "TriggerDelete",
              "CertificateView",
              "CertificateCreate",
              "CertificateEdit",
              "CertificateDelete",
              "CertificateExportPrivateKey",
              "UserEdit",
              "ConfigureServer",
              "FeedEdit",
              "WorkerView",
              "WorkerEdit",
              "SpaceEdit",
              "SpaceView",
              "SpaceDelete",
              "SpaceCreate",
              "BuildInformationPush",
              "BuildInformationAdminister",
              "RunbookView",
              "RunbookEdit",
              "RunbookSnapshotCreate",
              "RunbookRunView",
              "RunbookRunDelete",
              "RunbookRunCreate",
              "GitCredentialView",
              "GitCredentialEdit",
              "EventRetentionDelete",
              "EventRetentionView",
              "InsightsReportView",
              "InsightsReportCreate",
              "InsightsReportEdit",
              "InsightsReportDelete",
              "DeploymentFreezeAdminister",
              "TargetTagView",
              "TargetTagAdminister",
              "PlatformHubView",
              "PlatformHubEdit",
              "RetentionAdminister",
              "FeatureToggleEdit",
              "ApprovalPolicyAdminister",
              "SshKnownHostsAdminister",
              "SshKnownHostsView",
              "AiAgentTranscriptView",
              "DeployedResourceAdminister"
            ]
          }
        },
        "Id": {
          "type": "string",
          "description": "Id of the User Role to modify."
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ModifyVariablesByTenantIdCommand": {
      "type": "object",
      "required": [
        "Id",
        "SpaceId"
      ],
      "properties": {
        "ConcurrencyToken": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "ID of the Tenant to modify.",
          "example": "Tenants-1"
        },
        "LibraryVariables": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/ModifyVariablesByTenantIdCommandLibrary"
          }
        },
        "ProjectVariables": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/ModifyVariablesByTenantIdCommandProject"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ModifyVariablesByTenantIdCommandLibrary": {
      "type": "object",
      "required": [
        "LibraryVariableSetId"
      ],
      "properties": {
        "LibraryVariableSetId": {
          "type": "string",
          "example": "LibraryVariableSets-1"
        },
        "LibraryVariableSetName": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Templates": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          }
        },
        "Variables": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/PropertyValueResource"
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyVariablesByTenantIdCommandProject": {
      "type": "object",
      "required": [
        "ProjectId"
      ],
      "properties": {
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ProjectName": {
          "type": "string"
        },
        "Templates": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          }
        },
        "Variables": {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/definitions/PropertyValueResource"
            }
          }
        }
      },
      "additionalProperties": false
    },
    "ModifyVariableSetCommand": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "OwnerId": {
          "type": "string",
          "description": "Gets or sets the ID of the document that owns these variables."
        },
        "ScopeValues": {
          "$ref": "#/definitions/VariableScopeValues"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Variables": {
          "type": "array",
          "description": "Gets the collection of variables.",
          "items": {
            "$ref": "#/definitions/VariableResource"
          }
        },
        "Version": {
          "type": "integer",
          "description": "Gets or sets the version number.",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ModifyWorkerCommand": {
      "type": "object",
      "required": [
        "Endpoint",
        "Id",
        "IsDisabled",
        "Name",
        "SpaceId",
        "WorkerPoolIds"
      ],
      "properties": {
        "Endpoint": {
          "$ref": "#/definitions/EndpointResource"
        },
        "Id": {
          "type": "string",
          "description": "The ID of the worker",
          "example": "Machines-1"
        },
        "IsDisabled": {
          "type": "boolean",
          "description": "Whether the worker is disabled or not"
        },
        "MachinePolicyId": {
          "type": "string",
          "description": "The policy the worker must adhere to",
          "example": "MachinePolicies-1"
        },
        "Name": {
          "type": "string",
          "description": "The name of the worker",
          "minLength": 1
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        },
        "WorkerPoolIds": {
          "type": "array",
          "description": "The worker pools the worker belongs to",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "WorkerPools-1",
            "..."
          ]
        }
      },
      "additionalProperties": false
    },
    "ModifyWorkerPoolCommand": {
      "type": "object",
      "description": "Updates an existing worker pool.",
      "required": [
        "Id",
        "IsDefault",
        "Name",
        "SpaceId"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "description": "The description of the worker pool"
        },
        "Id": {
          "type": "string",
          "description": "The ID of the worker pool",
          "example": "WorkerPools-1"
        },
        "IsDefault": {
          "type": "boolean",
          "description": "Whether the worker pool is the default or not"
        },
        "Name": {
          "type": "string",
          "description": "The name of the worker pool",
          "minLength": 1
        },
        "Slug": {
          "type": "string",
          "description": "The slug of the worker pool"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        },
        "WorkerType": {
          "type": "string",
          "description": "The worker image"
        }
      },
      "additionalProperties": false
    },
    "MonitorErrorResource": {
      "type": "object",
      "required": [
        "ErrorCode",
        "ErrorMessage"
      ],
      "properties": {
        "ErrorCode": {
          "type": "string",
          "minLength": 1
        },
        "ErrorMessage": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "MultiTenancyStatusResource": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "NamedReferenceItem": {
      "type": "object",
      "properties": {
        "DisplayIdAndName": {
          "type": "boolean"
        },
        "DisplayName": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "NewGitCredentialDetails": {
      "type": "object",
      "required": [
        "Password",
        "Username"
      ],
      "properties": {
        "Password": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "Username": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "NewGitCredentialDetailsV2": {
      "type": "object",
      "required": [
        "Type"
      ],
      "properties": {
        "Type": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "NewPlatformHubGitCredentialDetails": {
      "type": "object",
      "required": [
        "Password",
        "Username"
      ],
      "properties": {
        "Password": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "Username": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "NewPlatformHubGitCredentialDetailsV2": {
      "type": "object",
      "required": [
        "Type"
      ],
      "properties": {
        "Type": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "OctopusBuildInformation": {
      "type": "object",
      "properties": {
        "Branch": {
          "type": "string"
        },
        "BuildEnvironment": {
          "type": "string"
        },
        "BuildNumber": {
          "type": "string"
        },
        "BuildUrl": {
          "type": "string"
        },
        "Commits": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Commit"
          }
        },
        "VcsCommitNumber": {
          "type": "string"
        },
        "VcsRoot": {
          "type": "string"
        },
        "VcsType": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "OctopusPackageVersionBuildInformationMappedResource": {
      "type": "object",
      "properties": {
        "Branch": {
          "type": "string"
        },
        "BuildEnvironment": {
          "type": "string"
        },
        "BuildNumber": {
          "type": "string"
        },
        "BuildUrl": {
          "type": "string"
        },
        "Commits": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CommitDetails"
          }
        },
        "Created": {
          "type": "string",
          "format": "date-time"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IncompleteDataWarning": {
          "type": "string"
        },
        "IssueTrackerName": {
          "type": "string"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "PackageId": {
          "type": "string"
        },
        "VcsCommitNumber": {
          "type": "string"
        },
        "VcsCommitUrl": {
          "type": "string"
        },
        "VcsRoot": {
          "type": "string"
        },
        "VcsType": {
          "type": "string"
        },
        "Version": {
          "type": "string"
        },
        "WorkItems": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkItemLink"
          }
        }
      },
      "additionalProperties": false
    },
    "OctopusPackageVersionBuildInformationMappedResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "OctopusServerClusterSummaryResource": {
      "type": "object",
      "properties": {
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Nodes": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/OctopusServerNodeSummaryResource"
          }
        }
      },
      "additionalProperties": false
    },
    "OctopusServerNodeDetailsResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "RunningTasks": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "OctopusServerNodeResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsInMaintenanceMode": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "MaxConcurrentTasks": {
          "type": "integer",
          "format": "int32"
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "OctopusServerNodeResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/OctopusServerNodeResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "OctopusServerNodeSummaryResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsInMaintenanceMode": {
          "type": "boolean"
        },
        "IsOffline": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastSeen": {
          "type": "string",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "MaxConcurrentTasks": {
          "type": "integer",
          "format": "int32"
        },
        "MaxSqlConnectionPoolSize": {
          "type": "integer",
          "format": "int32"
        },
        "Name": {
          "type": "string"
        },
        "RecommendedMaxSqlConnectionPoolSize": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "RunningTaskCount": {
          "type": "integer",
          "format": "int32"
        },
        "Version": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "OptionsMetadata": {
      "type": "object",
      "properties": {
        "SelectMode": {
          "type": "string"
        },
        "Values": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "PackageDescriptionResource": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "LatestVersion": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "PackageDescriptionResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PackageDescriptionResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PackageFromBuiltInFeedResource": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "FeedId": {
          "type": "string"
        },
        "FileExtension": {
          "type": "string"
        },
        "Hash": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NuGetFeedId": {
          "type": "string"
        },
        "NuGetPackageId": {
          "type": "string"
        },
        "PackageId": {
          "type": "string"
        },
        "PackageSizeBytes": {
          "type": "integer",
          "format": "int64"
        },
        "PackageVersionBuildInformation": {
          "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResource"
        },
        "Published": {
          "type": "string",
          "format": "date-time"
        },
        "ReleaseNotes": {
          "type": "string"
        },
        "Summary": {
          "type": "string"
        },
        "Title": {
          "type": "string"
        },
        "Version": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "PackageFromBuiltInFeedResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PackageFromBuiltInFeedResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PackageNote": {
      "type": "object",
      "properties": {
        "FeedId": {
          "type": "string"
        },
        "Notes": {
          "$ref": "#/definitions/PackageNotesResult"
        },
        "PackageId": {
          "type": "string"
        },
        "Version": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "PackageNoteListResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Packages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PackageNote"
          }
        }
      },
      "additionalProperties": false
    },
    "PackageNotesResult": {
      "type": "object",
      "properties": {
        "DisplayMessage": {
          "type": "string",
          "description": "The message to the display to the user, based on the success of the operation",
          "readOnly": true
        },
        "FailureReason": {
          "type": "string",
          "description": "The reason why the notes are not available if Succeeded is false"
        },
        "Notes": {
          "type": "string",
          "description": "The notes if Succeeded is true"
        },
        "Published": {
          "type": "string",
          "format": "date-time"
        },
        "Succeeded": {
          "type": "boolean",
          "description": "True if the notes were retrieved, and false otherwise"
        }
      },
      "additionalProperties": false
    },
    "PackageReferenceResource": {
      "type": "object",
      "properties": {
        "AcquisitionLocation": {
          "type": "string",
          "description": "The package-acquisition location. One of PackageAcquisitionLocationResource or a variable-expression"
        },
        "FeedId": {
          "type": "string",
          "description": "Feed ID, name or a variable-expression"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "description": "A name for the package-reference. This may be empty. This is used to discriminate the package-references. Package ID isn't suitable because an action may potentially have multiple references to the same package ID (e.g. if you wanted to use different versions of the same package). Also, the package ID may be a variable-expression."
        },
        "PackageId": {
          "type": "string",
          "description": "Package ID or a variable-expression"
        },
        "Properties": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "StepPackageInputsReferenceId": {
          "type": "string",
          "description": "This reference identifier is populated when a step package step contains a package reference It allows us to correlate the reference within the step package inputs to this Server package reference"
        },
        "Version": {
          "type": "string",
          "description": "Specific version to use for this package. If not specified, package can be selected at release creation or runbook run time."
        }
      },
      "additionalProperties": false
    },
    "PackageResource": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "FeedId": {
          "type": "string"
        },
        "FileExtension": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NuGetFeedId": {
          "type": "string"
        },
        "NuGetPackageId": {
          "type": "string"
        },
        "PackageId": {
          "type": "string"
        },
        "PackageVersionBuildInformation": {
          "$ref": "#/definitions/OctopusPackageVersionBuildInformationMappedResource"
        },
        "Published": {
          "type": "string",
          "format": "date-time"
        },
        "ReleaseNotes": {
          "type": "string"
        },
        "Summary": {
          "type": "string"
        },
        "Title": {
          "type": "string"
        },
        "Version": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "PackageSignatureResource": {
      "type": "object",
      "properties": {
        "BaseVersion": {
          "type": "string"
        },
        "Signature": {
          "type": "string",
          "format": "byte"
        }
      },
      "additionalProperties": false
    },
    "PackageVersionResource": {
      "type": "object",
      "properties": {
        "FeedId": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "PackageId": {
          "type": "string"
        },
        "Published": {
          "type": "string",
          "description": "Date the package was published. Optional Property",
          "format": "date-time"
        },
        "ReleaseNotes": {
          "type": "string",
          "description": "Release notes for the package."
        },
        "SizeBytes": {
          "type": "integer",
          "description": "Size of package in bytes. Optional Property",
          "format": "int64"
        },
        "Title": {
          "type": "string",
          "description": "Title of the package. This may be just the package name if the feed does not expose any version specific name."
        },
        "Version": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "PackageVersionResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PackageVersionResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PerformanceConfigurationResource": {
      "type": "object",
      "properties": {
        "DefaultDashboardRenderMode": {
          "type": "string",
          "enum": [
            "VirtualizeColumns",
            "VirtualizeRowsAndColumns"
          ]
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "PermissionDescription": {
      "type": "object",
      "properties": {
        "CanApplyAtSpaceLevel": {
          "type": "boolean",
          "readOnly": true
        },
        "CanApplyAtSystemLevel": {
          "type": "boolean",
          "readOnly": true
        },
        "Description": {
          "type": "string"
        },
        "SupportedRestrictions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "PersistenceSettingsResource": {
      "type": "object",
      "properties": {
        "Type": {
          "type": "string",
          "enum": [
            "Database",
            "VersionControlled"
          ],
          "readOnly": true
        }
      },
      "additionalProperties": false
    },
    "PhaseDeploymentResource": {
      "type": "object",
      "properties": {
        "Deployment": {
          "$ref": "#/definitions/DeploymentResource"
        },
        "Task": {
          "$ref": "#/definitions/TaskResource"
        }
      },
      "additionalProperties": false
    },
    "PhaseProgressionResource": {
      "type": "object",
      "properties": {
        "AutomaticDeploymentTargets": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Blocked": {
          "type": "boolean"
        },
        "Deployments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PhaseDeploymentResource"
          }
        },
        "Id": {
          "type": "string"
        },
        "IsOptionalPhase": {
          "type": "boolean"
        },
        "IsPriorityPhase": {
          "type": "boolean"
        },
        "MinimumEnvironmentsBeforePromotion": {
          "type": "integer",
          "format": "int32"
        },
        "Name": {
          "type": "string"
        },
        "OptionalDeploymentTargets": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Progress": {
          "type": "string",
          "enum": [
            "Pending",
            "Current",
            "Complete"
          ]
        }
      },
      "additionalProperties": false
    },
    "PhaseResource": {
      "type": "object",
      "properties": {
        "AutomaticDeploymentTargets": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Id": {
          "type": "string"
        },
        "IsOptionalPhase": {
          "type": "boolean"
        },
        "IsPriorityPhase": {
          "type": "boolean"
        },
        "MinimumEnvironmentsBeforePromotion": {
          "type": "integer",
          "format": "int32"
        },
        "Name": {
          "type": "string"
        },
        "OptionalDeploymentTargets": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "ReleaseRetentionPolicy": {
          "$ref": "#/definitions/RetentionPeriod"
        },
        "TentacleRetentionPolicy": {
          "$ref": "#/definitions/RetentionPeriod"
        }
      },
      "additionalProperties": false
    },
    "PlatformHubAccountResource": {
      "type": "object",
      "required": [
        "Details",
        "Id",
        "Name",
        "Slug"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/AccountDetailsResource"
        },
        "Id": {
          "type": "string",
          "example": "Accounts-1"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "PlatformHubAccountResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PlatformHubAccountResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PlatformHubCertificateResource": {
      "type": "object",
      "properties": {
        "Archived": {
          "type": "string",
          "format": "date-time"
        },
        "CertificateChain": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/X509Certificate"
          }
        },
        "CertificateData": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "CertificateDataFormat": {
          "type": "string",
          "enum": [
            "Pkcs12",
            "Der",
            "Pem",
            "Unknown"
          ]
        },
        "HasPrivateKey": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsExpired": {
          "type": "boolean"
        },
        "IssuerCommonName": {
          "type": "string"
        },
        "IssuerDistinguishedName": {
          "type": "string"
        },
        "IssuerOrganization": {
          "type": "string"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "NotAfter": {
          "type": "string",
          "format": "date-time"
        },
        "NotBefore": {
          "type": "string",
          "format": "date-time"
        },
        "Notes": {
          "type": "string"
        },
        "Password": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "ReplacedBy": {
          "type": "string"
        },
        "SelfSigned": {
          "type": "boolean"
        },
        "SerialNumber": {
          "type": "string"
        },
        "SignatureAlgorithmName": {
          "type": "string"
        },
        "Slug": {
          "type": "string",
          "description": "The slug of the certificate."
        },
        "SubjectAlternativeNames": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SubjectCommonName": {
          "type": "string",
          "description": "The certificate subject's common name (CN). When creating a self-signed certificate this becomes the generated certificate's CN, and at least one of SubjectCommonName or SubjectOrganization must be supplied."
        },
        "SubjectDistinguishedName": {
          "type": "string"
        },
        "SubjectOrganization": {
          "type": "string",
          "description": "The certificate subject's organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied."
        },
        "Thumbprint": {
          "type": "string"
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PlatformHubCertificateResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PlatformHubCertificateResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PlatformHubCertificateUsageResource": {
      "type": "object",
      "properties": {
        "DefaultBranchProcessTemplateUsageCount": {
          "type": "integer",
          "format": "int32"
        },
        "DefaultBranchProcessTemplateUsages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PlatformHubTemplateUsageResource"
          }
        },
        "DefaultBranchProjectTemplateUsageCount": {
          "type": "integer",
          "format": "int32"
        },
        "DefaultBranchProjectTemplateUsages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PlatformHubTemplateUsageResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProcessTemplateVersionUsageCount": {
          "type": "integer",
          "format": "int32"
        },
        "ProcessTemplateVersionUsages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PlatformHubTemplateVersionUsageResource"
          }
        },
        "ProjectTemplateVersionUsageCount": {
          "type": "integer",
          "format": "int32"
        },
        "ProjectTemplateVersionUsages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PlatformHubTemplateVersionUsageResource"
          }
        },
        "TotalUsageCount": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PlatformHubFeedResource": {
      "type": "object",
      "required": [
        "FeedType",
        "Id",
        "Name",
        "Slug"
      ],
      "properties": {
        "FeedType": {
          "type": "string",
          "enum": [
            "None",
            "NuGet",
            "Docker",
            "Maven",
            "OctopusProject",
            "GitHub",
            "Helm",
            "OciRegistry",
            "AwsElasticContainerRegistry",
            "BuiltIn",
            "S3",
            "AzureContainerRegistry",
            "GoogleContainerRegistry",
            "ArtifactoryGeneric",
            "Npm",
            "GcsStorage",
            "PyPi"
          ]
        },
        "Id": {
          "type": "string"
        },
        "LastModifiedBy": {
          "type": "string"
        },
        "LastModifiedOn": {
          "type": "string",
          "format": "date-time"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "PackageAcquisitionLocationOptions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "Server",
              "ExecutionTarget",
              "NotAcquired"
            ]
          }
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "PlatformHubFeedResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PlatformHubFeedResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PlatformHubGitCredentialResource": {
      "type": "object",
      "required": [
        "Details",
        "Id",
        "Name",
        "RepositoryRestrictions"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/GitCredentialDetailsResource"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "RepositoryRestrictions": {
          "$ref": "#/definitions/GitCredentialRepositoryRestrictionsResource"
        }
      },
      "additionalProperties": false
    },
    "PlatformHubGitCredentialResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PlatformHubGitCredentialResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PlatformHubGitCredentialResourceV2": {
      "type": "object",
      "required": [
        "Details",
        "Id",
        "Name",
        "RepositoryRestrictions"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Details": {
          "$ref": "#/definitions/GitCredentialDetailsResourceV2"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "RepositoryRestrictions": {
          "$ref": "#/definitions/GitCredentialRepositoryRestrictionsResourceV2"
        }
      },
      "additionalProperties": false
    },
    "PlatformHubGitCredentialResourceV2PaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PlatformHubGitCredentialResourceV2"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PlatformHubPackageDescriptionResource": {
      "type": "object",
      "required": [
        "Id"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "minLength": 1
        },
        "LatestVersion": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "PlatformHubPackageDescriptionResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PlatformHubPackageDescriptionResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PlatformHubPackageVersionResource": {
      "type": "object",
      "required": [
        "FeedId",
        "Id",
        "PackageId",
        "Version"
      ],
      "properties": {
        "FeedId": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "minLength": 1
        },
        "PackageId": {
          "type": "string",
          "minLength": 1
        },
        "Published": {
          "type": "string",
          "format": "date-time"
        },
        "ReleaseNotes": {
          "type": "string"
        },
        "SizeBytes": {
          "type": "integer",
          "format": "int64"
        },
        "Title": {
          "type": "string"
        },
        "Version": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "PlatformHubPackageVersionResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PlatformHubPackageVersionResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PlatformHubTemplateUsageResource": {
      "type": "object",
      "required": [
        "GitRef",
        "Id",
        "Name",
        "Slug",
        "UsageSource"
      ],
      "properties": {
        "GitRef": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string",
          "minLength": 1
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "UsageSource": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "PlatformHubTemplateVersionUsageResource": {
      "type": "object",
      "required": [
        "GitRef",
        "Id",
        "Name",
        "Slug",
        "Version"
      ],
      "properties": {
        "GitRef": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string",
          "minLength": 1
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "PublishedDate": {
          "type": "string",
          "format": "date-time"
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "Version": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "PlatformHubVersionControlSettingsResource": {
      "type": "object",
      "required": [
        "BasePath",
        "Credentials",
        "DefaultBranch"
      ],
      "properties": {
        "BasePath": {
          "type": "string"
        },
        "Credentials": {
          "$ref": "#/definitions/GitCredentialUsageResource"
        },
        "DefaultBranch": {
          "type": "string"
        },
        "Url": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ProcessReferenceDataItem": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "ProcessType": {
          "type": "string",
          "enum": [
            "Deployment",
            "Runbook"
          ]
        }
      },
      "additionalProperties": false
    },
    "ProcessTemplateParameterResource": {
      "type": "object",
      "properties": {
        "DisplaySettings": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "HelpText": {
          "type": "string"
        },
        "IsOptional": {
          "type": "boolean"
        },
        "Label": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "Values": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TemplateParameterValueResource"
          }
        }
      },
      "additionalProperties": false
    },
    "ProcessTemplateResource": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "GitRef": {
          "type": "string"
        },
        "Icon": {
          "$ref": "#/definitions/IconResource"
        },
        "Id": {
          "type": "string",
          "readOnly": true
        },
        "Name": {
          "type": "string"
        },
        "Parameters": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ProcessTemplateParameterResource"
          },
          "readOnly": true
        },
        "Slug": {
          "type": "string"
        },
        "Steps": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentStepResource"
          },
          "readOnly": true
        }
      },
      "additionalProperties": false
    },
    "ProcessTemplateVersionResource": {
      "type": "object",
      "required": [
        "GitCommit",
        "GitRef",
        "Id",
        "IsPreRelease",
        "Name",
        "Parameters",
        "PublishedDate",
        "Slug",
        "Steps",
        "Version"
      ],
      "properties": {
        "Description": {
          "type": "string"
        },
        "GitCommit": {
          "type": "string"
        },
        "GitRef": {
          "type": "string",
          "minLength": 1
        },
        "Icon": {
          "$ref": "#/definitions/IconResource"
        },
        "Id": {
          "type": "string",
          "example": "ProcessTemplateVersion-1"
        },
        "IsPreRelease": {
          "type": "boolean"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Parameters": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ProcessTemplateParameterResource"
          }
        },
        "PublishedDate": {
          "type": "string",
          "format": "date-time"
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "Steps": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentStepResource"
          }
        },
        "Version": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ProgressionResource": {
      "type": "object",
      "properties": {
        "ChannelEnvironments": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/ReferenceDataItem"
            }
          }
        },
        "Environments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LifecycleEnvironments": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/ReferenceDataItem"
            }
          }
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Releases": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseProgressionResource"
          }
        }
      },
      "additionalProperties": false
    },
    "Project": {
      "type": "object",
      "properties": {
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectId": {
          "type": "string"
        },
        "ProjectName": {
          "type": "string"
        },
        "Templates": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          }
        },
        "Variables": {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/definitions/PropertyValueResource"
            }
          }
        }
      },
      "additionalProperties": false
    },
    "ProjectDocumentCounts": {
      "type": "object",
      "properties": {
        "Deployments": {
          "type": "integer",
          "format": "int32"
        },
        "Projects": {
          "type": "integer",
          "format": "int32"
        },
        "Releases": {
          "type": "integer",
          "format": "int32"
        },
        "RunbookRuns": {
          "type": "integer",
          "format": "int32"
        },
        "Runbooks": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ProjectedTeamReferenceDataItem": {
      "type": "object",
      "properties": {
        "ExternalSecurityGroups": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/NamedReferenceItem"
          }
        },
        "Id": {
          "type": "string"
        },
        "IsDirectlyAssigned": {
          "type": "boolean"
        },
        "Name": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ProjectGroupResource": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "EnvironmentIds": {
          "type": "array",
          "description": "Gets or sets a collection of environment ID's. If this collection is empty, projects in this group can be deployed to any environment. If the collection is non-empty, then projects in the group are limited to only deploying to the environments listed in this collection. Obsolete. Environments are now controlled by lifecycles as of Oct 2014, version 2.6.5.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "description": "Gets or sets the name of this project group."
        },
        "RetentionPolicyId": {
          "type": "string",
          "description": "Gets or sets the ID of the retention policy that will apply to projects in this group."
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ProjectGroupResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ProjectGroupResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ProjectResource": {
      "type": "object",
      "properties": {
        "AllowIgnoreChannelRules": {
          "type": "boolean"
        },
        "AutoCreateRelease": {
          "type": "boolean"
        },
        "AutoDeployReleaseOverrides": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "$ref": "#/definitions/AutoDeployReleaseOverrideResource"
          },
          "readOnly": true
        },
        "ClonedFromProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "CombineHealthAndSyncStatusInDashboardLiveStatus": {
          "type": "boolean"
        },
        "DefaultGuidedFailureMode": {
          "type": "string",
          "enum": [
            "EnvironmentDefault",
            "Off",
            "On"
          ]
        },
        "DefaultPowerShellEdition": {
          "type": "string"
        },
        "DefaultToSkipIfAlreadyInstalled": {
          "type": "boolean"
        },
        "DeploymentChangesTemplate": {
          "type": "string"
        },
        "DeploymentProcessId": {
          "type": "string"
        },
        "DeprovisioningRunbookId": {
          "type": "string",
          "example": "Runbooks-1"
        },
        "Description": {
          "type": "string"
        },
        "DiscreteChannelRelease": {
          "type": "boolean",
          "description": "Treats releases of different channels to the same environment as a seperate deployment dimension. 'False' indicates a \"hotfix\"-style usage of channels (single release active per environment ignoring channels), whereas `True` indicates \"microservice\"-style usage (single release per environment per channel)"
        },
        "ExecuteDeploymentsOnEventBasedPipeline": {
          "type": "boolean"
        },
        "ExtensionSettings": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ExtensionSettingsValues"
          },
          "readOnly": true
        },
        "ForcePackageDownload": {
          "type": "boolean"
        },
        "Icon": {
          "$ref": "#/definitions/IconResource"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IncludedLibraryVariableSetIds": {
          "type": "array",
          "description": "Library variable sets included in the project. Sets are listed in order of precedence, with earlier items in the list overriding any variables with the same name and scope definition appearing later in the list.",
          "items": {
            "type": "string"
          }
        },
        "IsBadgesEnabled": {
          "type": "boolean"
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "IsVersionControlled": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LifecycleId": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "PersistenceSettings": {
          "$ref": "#/definitions/PersistenceSettingsResource"
        },
        "ProjectConnectivityPolicy": {
          "$ref": "#/definitions/DeploymentConnectivityPolicy"
        },
        "ProjectGroupId": {
          "type": "string"
        },
        "ProjectTags": {
          "type": "array",
          "description": "List of tags assigned to this project",
          "items": {
            "type": "string"
          }
        },
        "ProjectTemplateDetails": {
          "$ref": "#/definitions/ProjectTemplateDetailsResource"
        },
        "ProvisioningRunbookId": {
          "type": "string",
          "example": "Runbooks-1"
        },
        "ReleaseCreationStrategy": {
          "$ref": "#/definitions/ReleaseCreationStrategyResource"
        },
        "ReleaseNotesTemplate": {
          "type": "string"
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Templates": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActionTemplateParameterResource"
          }
        },
        "TenantedDeploymentMode": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "VariableSetId": {
          "type": "string"
        },
        "VersioningStrategy": {
          "$ref": "#/definitions/VersioningStrategyResource"
        }
      },
      "additionalProperties": false
    },
    "ProjectResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ProjectResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ProjectSettingsMetadata": {
      "type": "object",
      "required": [
        "ExtensionId",
        "Metadata"
      ],
      "properties": {
        "ExtensionId": {
          "type": "string",
          "minLength": 1
        },
        "Metadata": {
          "$ref": "#/definitions/Metadata"
        }
      },
      "additionalProperties": false
    },
    "ProjectTemplateDetailsResource": {
      "type": "object",
      "required": [
        "Slug",
        "VersionMask"
      ],
      "properties": {
        "IsShared": {
          "type": "boolean"
        },
        "Slug": {
          "type": "string"
        },
        "VersionMask": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ProjectTenantVariableEntry": {
      "type": "object",
      "properties": {
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "TenantVariableIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "ProjectTenantVariableUsage": {
      "type": "object",
      "properties": {
        "Projects": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ProjectTenantVariableEntry"
          }
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        }
      },
      "additionalProperties": false
    },
    "ProjectTriggerResource": {
      "type": "object",
      "properties": {
        "Action": {
          "$ref": "#/definitions/TriggerActionResource"
        },
        "Description": {
          "type": "string"
        },
        "Filter": {
          "$ref": "#/definitions/TriggerFilterResource"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ProjectTriggerResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ProjectTriggerResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ProjectVariableScope": {
      "type": "object",
      "required": [
        "EnvironmentIds"
      ],
      "properties": {
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        }
      },
      "additionalProperties": false
    },
    "ProjectVariableSetUsage": {
      "type": "object",
      "properties": {
        "IsCurrentlyBeingUsedInProject": {
          "type": "boolean"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ProjectName": {
          "type": "string"
        },
        "ProjectSlug": {
          "type": "string"
        },
        "Releases": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseUsageEntry"
          }
        },
        "RunbookSnapshots": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookSnapshotUsageEntry"
          }
        }
      },
      "additionalProperties": false
    },
    "ProjectVariablesResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "OwnerId": {
          "type": "string",
          "description": "Gets or sets the ID of the document that owns these variables."
        },
        "ScopeValues": {
          "$ref": "#/definitions/VariableScopeValues"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Variables": {
          "type": "array",
          "description": "Gets the collection of variables.",
          "items": {
            "$ref": "#/definitions/VariableResource"
          }
        },
        "Version": {
          "type": "integer",
          "description": "Gets or sets the version number.",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PropertyApplicability": {
      "type": "object",
      "properties": {
        "DependsOnPropertyName": {
          "type": "string"
        },
        "DependsOnPropertyValue": { },
        "Mode": {
          "type": "string",
          "enum": [
            "ApplicableIfHasAnyValue",
            "ApplicableIfHasNoValue",
            "ApplicableIfSpecificValue",
            "ApplicableIfNotSpecificValue"
          ]
        }
      },
      "additionalProperties": false
    },
    "PropertyMetadata": {
      "type": "object",
      "properties": {
        "DisplayInfo": {
          "$ref": "#/definitions/DisplayInfo"
        },
        "Name": {
          "type": "string"
        },
        "Type": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "PropertyValueResource": {
      "type": "object",
      "properties": {
        "IsSensitive": {
          "type": "boolean"
        },
        "SensitiveValue": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "Value": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ProxyResource": {
      "type": "object",
      "properties": {
        "Host": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "Password": {
          "$ref": "#/definitions/SensitiveValue"
        },
        "Port": {
          "type": "integer",
          "format": "int32"
        },
        "ProxyType": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Username": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ProxyResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ProxyResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PublishCompliancePolicyCommand": {
      "type": "object",
      "required": [
        "GitRef",
        "Slug",
        "Version"
      ],
      "properties": {
        "GitRef": {
          "type": "string"
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        },
        "Version": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "RateLimitingPolicyResource": {
      "type": "object",
      "description": "A rate limiting policy that controls request throughput using token bucket semantics.",
      "required": [
        "AuditMode",
        "BurstLimit",
        "Id",
        "IsBuiltIn",
        "IsEnabled",
        "Name",
        "RequestsPerMinute",
        "ScopeType"
      ],
      "properties": {
        "AuditMode": {
          "type": "boolean",
          "description": "When enabled, the policy logs requests that would be rate limited without rejecting them (no 429 response)."
        },
        "BurstLimit": {
          "type": "integer",
          "description": "Maximum capacity of the token bucket.",
          "format": "int32",
          "example": 200
        },
        "Id": {
          "type": "string",
          "description": "The ID of this policy.",
          "example": "RateLimitingPolicies-1"
        },
        "IsBuiltIn": {
          "type": "boolean",
          "description": "Whether this is a built-in policy that cannot be deleted or have its name or scope changed."
        },
        "IsEnabled": {
          "type": "boolean",
          "description": "Whether this policy is actively enforced."
        },
        "Name": {
          "type": "string",
          "description": "The display name of this policy.",
          "minLength": 1,
          "example": "Authenticated requests"
        },
        "RequestsPerMinute": {
          "type": "integer",
          "description": "Number of requests permitted per minute.",
          "format": "int32",
          "example": 600
        },
        "ScopeType": {
          "type": "string",
          "description": "The scope this policy applies to."
        }
      },
      "additionalProperties": false
    },
    "RateLimitingPolicyResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RateLimitingPolicyResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "RecoverGitHubAppConnectionCommand": {
      "type": "object",
      "required": [
        "Id",
        "RepositoryIds",
        "SpaceId"
      ],
      "properties": {
        "Id": {
          "type": "string"
        },
        "RepositoryIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "RecoverGitHubAppConnectionResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "RecoverNotFoundGitHubAppConnectionCommand": {
      "type": "object",
      "required": [
        "Id",
        "InstallationId",
        "RepositoryIds",
        "SpaceId"
      ],
      "properties": {
        "Id": {
          "type": "string"
        },
        "InstallationId": {
          "type": "string"
        },
        "RepositoryIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "RecoverNotFoundGitHubAppConnectionResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "RecoverPlatformHubGitHubAppConnectionCommand": {
      "type": "object",
      "required": [
        "Id",
        "RepositoryIds"
      ],
      "properties": {
        "Id": {
          "type": "string"
        },
        "RepositoryIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "RecoverPlatformHubGitHubAppConnectionResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "RecurringScheduleResource": {
      "type": "object",
      "properties": {
        "EndAfterOccurrences": {
          "type": "integer",
          "format": "int32"
        },
        "EndDate": {
          "type": "string",
          "format": "date-time"
        },
        "EndOnDate": {
          "type": "string",
          "format": "date-time"
        },
        "EndType": {
          "type": "string",
          "enum": [
            "Never",
            "OnDate",
            "AfterOccurrences"
          ]
        },
        "StartDate": {
          "type": "string",
          "format": "date-time"
        },
        "Type": {
          "type": "string",
          "enum": [
            "Daily",
            "Weekly",
            "Monthly",
            "Annually"
          ],
          "readOnly": true
        },
        "Unit": {
          "type": "integer",
          "format": "int32"
        },
        "UserUtcOffsetInMinutes": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ReferenceDataItem": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "RefreshGitHubAppConnectionByIdResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "RefreshGitHubAppUserResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "RefreshPlatformHubGitHubAppConnectionByIdResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "RefreshRunbookSnapshotVariablesCommand": {
      "type": "object",
      "description": "Update the variable snapshots associated with the runbook snapshot to the latest versions. The runbook's process must not have changed since the snapshot was created.",
      "required": [
        "Id",
        "SpaceId"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "description": "The ID of the runbook snapshot whose variables to refresh, e.g. 'RunbookSnapshots-123'.",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "description": "The ID of the project containing this resource. Will be inferred if not provided.",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        },
        "VariableSnapshotConcurrencyToken": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "RefreshRunbookSnapshotVariablesResponse": {
      "type": "object",
      "required": [
        "Resource"
      ],
      "properties": {
        "Resource": {
          "$ref": "#/definitions/RunbookSnapshotResource"
        }
      },
      "additionalProperties": false
    },
    "RegisterKubernetesMonitorCommand": {
      "type": "object",
      "required": [
        "InstallationId",
        "MachineId",
        "SpaceId"
      ],
      "properties": {
        "InstallationId": {
          "type": "string",
          "description": "Installation ID of that uniquely identifies the physical installation of the agent.",
          "format": "uuid"
        },
        "MachineId": {
          "type": "string",
          "description": "Machine ID of that uniquely identifies the deployment target or worker that is being observed",
          "example": "Machines-1"
        },
        "PreserveAuthenticationToken": {
          "type": "boolean",
          "description": "Controls whether the authentication token should be preserved during re-registration. If not supplied (null), the token will be regenerated (default behavior). If false, the token will be regenerated. If true, the existing token will be preserved."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "RegisterKubernetesMonitorResponse": {
      "type": "object",
      "required": [
        "CertificateThumbprint",
        "Resource"
      ],
      "properties": {
        "AuthenticationToken": {
          "type": "string",
          "description": "Authentication token for the monitor. Will be null if PreserveAuthenticationToken was set to true in the request and not registering a new monitor"
        },
        "CertificateThumbprint": {
          "type": "string",
          "minLength": 1
        },
        "Resource": {
          "$ref": "#/definitions/KubernetesMonitorResource"
        }
      },
      "additionalProperties": false
    },
    "RegisterUserCommand": {
      "type": "object",
      "required": [
        "DisplayName",
        "InvitationCode",
        "Password",
        "Username"
      ],
      "properties": {
        "DisplayName": {
          "type": "string",
          "minLength": 1
        },
        "EmailAddress": {
          "type": "string"
        },
        "Identities": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/IdentityResource"
          }
        },
        "InvitationCode": {
          "type": "string",
          "minLength": 1
        },
        "Password": {
          "type": "string",
          "minLength": 1
        },
        "Username": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ReleaseChangesResource": {
      "type": "object",
      "properties": {
        "BuildInformation": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleasePackageVersionBuildInformation"
          }
        },
        "Commits": {
          "type": "array",
          "description": "Aggregate of distinct commits from all VersionMetadata",
          "items": {
            "$ref": "#/definitions/CommitDetails"
          }
        },
        "ReleaseNotes": {
          "type": "string"
        },
        "Version": {
          "type": "string"
        },
        "WorkItems": {
          "type": "array",
          "description": "Aggregate of distinct work items from all VersionMetadata",
          "items": {
            "$ref": "#/definitions/WorkItemLink"
          }
        }
      },
      "additionalProperties": false
    },
    "ReleaseCreationStrategyResource": {
      "type": "object",
      "properties": {
        "ChannelId": {
          "type": "string"
        },
        "ReleaseCreationPackage": {
          "$ref": "#/definitions/DeploymentActionPackageResource"
        }
      },
      "additionalProperties": { }
    },
    "ReleasePackageVersionBuildInformation": {
      "type": "object",
      "properties": {
        "Branch": {
          "type": "string"
        },
        "BuildEnvironment": {
          "type": "string"
        },
        "BuildNumber": {
          "type": "string"
        },
        "BuildUrl": {
          "type": "string"
        },
        "Commits": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CommitDetails"
          }
        },
        "PackageId": {
          "type": "string"
        },
        "VcsCommitNumber": {
          "type": "string"
        },
        "VcsCommitUrl": {
          "type": "string"
        },
        "VcsRoot": {
          "type": "string"
        },
        "VcsType": {
          "type": "string"
        },
        "Version": {
          "type": "string"
        },
        "WorkItems": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkItemLink"
          }
        }
      },
      "additionalProperties": false
    },
    "ReleasePackageVersionBuildInformationResource": {
      "type": "object",
      "properties": {
        "Branch": {
          "type": "string"
        },
        "BuildEnvironment": {
          "type": "string"
        },
        "BuildNumber": {
          "type": "string"
        },
        "BuildUrl": {
          "type": "string"
        },
        "Commits": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CommitDetails"
          }
        },
        "IssueTrackerName": {
          "type": "string"
        },
        "PackageId": {
          "type": "string"
        },
        "VcsCommitNumber": {
          "type": "string"
        },
        "VcsCommitUrl": {
          "type": "string"
        },
        "VcsRoot": {
          "type": "string"
        },
        "VcsType": {
          "type": "string"
        },
        "Version": {
          "type": "string"
        },
        "WorkItems": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkItemLink"
          }
        }
      },
      "additionalProperties": false
    },
    "ReleaseProgressionResource": {
      "type": "object",
      "properties": {
        "Channel": {
          "$ref": "#/definitions/ChannelResource"
        },
        "Deployments": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/DashboardItemResource"
            }
          }
        },
        "HasUnresolvedDefect": {
          "type": "boolean"
        },
        "NextDeployments": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Release": {
          "$ref": "#/definitions/ReleaseResource"
        },
        "ReleaseRetentionPeriod": {
          "$ref": "#/definitions/RetentionPeriod"
        },
        "TentacleRetentionPeriod": {
          "$ref": "#/definitions/RetentionPeriod"
        }
      },
      "additionalProperties": false
    },
    "ReleaseResource": {
      "type": "object",
      "required": [
        "Version"
      ],
      "properties": {
        "Assembled": {
          "type": "string",
          "format": "date-time"
        },
        "BuildInformation": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleasePackageVersionBuildInformationResource"
          }
        },
        "ChannelId": {
          "type": "string",
          "example": "Channels-1"
        },
        "CustomFields": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource.",
          "example": "Releases-1"
        },
        "IgnoreChannelRules": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LibraryVariableSetSnapshotIds": {
          "type": "array",
          "description": "Snapshots of the project's included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.",
          "items": {
            "type": "string"
          }
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectDeploymentProcessSnapshotId": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ProjectVariableSetSnapshotId": {
          "type": "string"
        },
        "ReleaseNotes": {
          "type": "string"
        },
        "SelectedGitResources": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SelectedGitResource"
          }
        },
        "SelectedPackages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SelectedPackage"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "VariableSnapshotConcurrencyToken": {
          "type": "string",
          "description": "Identifies the release's current variable snapshots."
        },
        "Version": {
          "type": "string",
          "maxLength": 349,
          "minLength": 0
        },
        "VersionControlReference": {
          "$ref": "#/definitions/SnapshotGitReferenceResource"
        }
      },
      "additionalProperties": false
    },
    "ReleaseResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ReleaseTemplateGitResource": {
      "type": "object",
      "required": [
        "ActionName",
        "DefaultBranch",
        "IsResolvable",
        "Name",
        "RepositoryUri"
      ],
      "properties": {
        "ActionName": {
          "type": "string",
          "minLength": 1
        },
        "DefaultBranch": {
          "type": "string",
          "minLength": 1
        },
        "FilePathFilters": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "GitCredentialId": {
          "type": "string"
        },
        "GitHubConnectionId": {
          "type": "string"
        },
        "GitResourceSelectedLastRelease": {
          "$ref": "#/definitions/GitReferenceResource"
        },
        "IsResolvable": {
          "type": "boolean"
        },
        "Name": {
          "type": "string"
        },
        "RepositoryUri": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ReleaseTemplatePackage": {
      "type": "object",
      "properties": {
        "ActionName": {
          "type": "string"
        },
        "FeedId": {
          "type": "string"
        },
        "FeedName": {
          "type": "string"
        },
        "FixedVersion": {
          "type": "string"
        },
        "IsResolvable": {
          "type": "boolean",
          "description": "Gets or sets a value indicating whether the PackageId or FeedId contain no references to other variables. Variables can be used to select different NuGet feeds or packages at deployment time, however, this means that it's not possible to resolve which feed/package to search when creating a release."
        },
        "NuGetFeedId": {
          "type": "string"
        },
        "NuGetFeedName": {
          "type": "string"
        },
        "NuGetPackageId": {
          "type": "string"
        },
        "PackageId": {
          "type": "string"
        },
        "PackageReferenceName": {
          "type": "string"
        },
        "ProjectName": {
          "type": "string"
        },
        "StepName": {
          "type": "string"
        },
        "VersionSelectedLastRelease": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ReleaseTemplateResource": {
      "type": "object",
      "properties": {
        "DeploymentProcessId": {
          "type": "string"
        },
        "GitResources": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseTemplateGitResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastReleaseVersion": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NextVersionIncrement": {
          "type": "string"
        },
        "Packages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseTemplatePackage"
          }
        },
        "VersioningPackageReferenceName": {
          "type": "string"
        },
        "VersioningPackageStepName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ReleaseUsage": {
      "type": "object",
      "properties": {
        "ProjectId": {
          "type": "string"
        },
        "ProjectName": {
          "type": "string"
        },
        "Releases": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseUsageEntry"
          }
        }
      },
      "additionalProperties": false
    },
    "ReleaseUsageEntry": {
      "type": "object",
      "properties": {
        "ReleaseId": {
          "type": "string",
          "example": "Releases-1"
        },
        "ReleaseVersion": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ReplaceCertificateCommand": {
      "type": "object",
      "required": [
        "CertificateData",
        "Id",
        "SpaceId"
      ],
      "properties": {
        "CertificateData": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string",
          "description": "ID of the Certificate to Replace",
          "example": "Certificates-1"
        },
        "Password": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ReplacePlatformHubCertificateCommand": {
      "type": "object",
      "required": [
        "CertificateData",
        "Id"
      ],
      "properties": {
        "CertificateData": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string"
        },
        "Password": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "RequireCapabilityResponseV1": {
      "type": "object",
      "required": [
        "Exists"
      ],
      "properties": {
        "Exists": {
          "type": "boolean",
          "description": "If true, the server has this capability and you can use it. If not, the capability is not available on this server."
        }
      },
      "additionalProperties": false
    },
    "ResetGitHubAppRegistrationResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "RetentionDefaultConfigurationResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "RetentionDays": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "RetentionPeriod": {
      "type": "object",
      "properties": {
        "QuantityToKeep": {
          "type": "integer",
          "format": "int32"
        },
        "ShouldKeepForever": {
          "type": "boolean",
          "readOnly": true
        },
        "Strategy": {
          "type": "string"
        },
        "Unit": {
          "type": "string",
          "enum": [
            "Days",
            "Items"
          ]
        }
      },
      "additionalProperties": false
    },
    "RetryDeprovisioningEphemeralEnvironmentResponse": {
      "type": "object",
      "required": [
        "DeprovisioningRun"
      ],
      "properties": {
        "DeprovisioningRun": {
          "$ref": "#/definitions/EphemeralEnvironmentRunbookRun"
        }
      },
      "additionalProperties": false
    },
    "RetryGitRunbookRunResponse": {
      "type": "object",
      "required": [
        "Resource"
      ],
      "properties": {
        "Resource": {
          "$ref": "#/definitions/RunbookRunResource"
        }
      },
      "additionalProperties": false
    },
    "RetryProvisioningEphemeralEnvironmentResponse": {
      "type": "object",
      "required": [
        "ProvisioningRun"
      ],
      "properties": {
        "ProvisioningRun": {
          "$ref": "#/definitions/EphemeralEnvironmentRunbookRun"
        }
      },
      "additionalProperties": false
    },
    "RevokeUserSessionsResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "RolloutGroupResource": {
      "type": "object",
      "required": [
        "FeatureToggleUsages",
        "Id",
        "Name",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "FeatureToggleUsages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/FeatureToggleUsage"
          }
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "RolloutGroupResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RolloutGroupResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "RootResource": {
      "type": "object",
      "properties": {
        "ApiVersion": {
          "type": "string"
        },
        "Application": {
          "type": "string"
        },
        "HasLongTermSupport": {
          "type": "boolean",
          "description": "Every release from 2020.1 onwards of Octopus Server comes with long-term support. I wanted to remove this from the API, but that would be a breaking change. @michaelnoonan 2020-04-20",
          "readOnly": true
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "InstallationId": {
          "type": "string",
          "format": "uuid"
        },
        "IsEarlyAccessProgram": {
          "type": "boolean",
          "default": false
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Version": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "RotateFeatureToggleClientIdentifierSigningKeyCommand": {
      "type": "object",
      "required": [
        "CompleteRotation",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "CompleteRotation": {
          "type": "boolean"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "RotateFeatureToggleClientIdentifierSigningKeyResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "RunbookProcessResource": {
      "type": "object",
      "required": [
        "Version"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastSnapshotId": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "RunbookId": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Steps": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentStepResource"
          },
          "readOnly": true
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "RunbookProcessResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookProcessResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "RunbookResource": {
      "type": "object",
      "properties": {
        "CancelQueuedTasks": {
          "type": "boolean"
        },
        "CancelRunningTasks": {
          "type": "boolean"
        },
        "ConnectivityPolicy": {
          "$ref": "#/definitions/DeploymentConnectivityPolicy"
        },
        "DefaultGuidedFailureMode": {
          "type": "string",
          "enum": [
            "EnvironmentDefault",
            "Off",
            "On"
          ]
        },
        "Description": {
          "type": "string"
        },
        "Environments": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "readOnly": true,
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "EnvironmentScope": {
          "type": "string",
          "enum": [
            "All",
            "Specified",
            "FromProjectLifecycles"
          ]
        },
        "FailTargetDiscovery": {
          "type": "boolean"
        },
        "ForcePackageDownload": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "MultiTenancyMode": {
          "type": "string",
          "enum": [
            "Untenanted",
            "TenantedOrUntenanted",
            "Tenanted"
          ]
        },
        "Name": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "PublishedRunbookSnapshotId": {
          "type": "string"
        },
        "RunbookProcessId": {
          "type": "string"
        },
        "RunbookTags": {
          "type": "array",
          "description": "List of tags assigned to this runbook",
          "items": {
            "type": "string"
          }
        },
        "RunRetentionPolicy": {
          "$ref": "#/definitions/RunbookRetentionPolicy"
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "RunbookResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "RunbookRetentionPolicy": {
      "type": "object",
      "properties": {
        "QuantityToKeep": {
          "type": "integer",
          "format": "int32"
        },
        "ShouldKeepForever": {
          "type": "boolean",
          "readOnly": true
        },
        "Strategy": {
          "type": "string"
        },
        "Unit": {
          "type": "string",
          "enum": [
            "Days",
            "Items"
          ]
        }
      },
      "additionalProperties": false
    },
    "RunbookRunPreviewResource": {
      "type": "object",
      "properties": {
        "Form": {
          "$ref": "#/definitions/Form"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "StepsToExecute": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentTemplateStep"
          }
        },
        "UseGuidedFailureModeByDefault": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "RunbookRunResource": {
      "type": "object",
      "required": [
        "EnvironmentId",
        "RunbookId",
        "RunbookSnapshotId"
      ],
      "properties": {
        "ChangeRequestSettings": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ChangeRequestSettings"
          }
        },
        "Comments": {
          "type": "string"
        },
        "Created": {
          "type": "string",
          "format": "date-time"
        },
        "DebugMode": {
          "type": "string"
        },
        "DeployedBy": {
          "type": "string"
        },
        "DeployedById": {
          "type": "string"
        },
        "DeployedToMachineIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "ExcludedMachineIds": {
          "type": "array",
          "description": "A collection of machines in the target environment that should be excluded from the deployment.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ExcludedTargetTagIds": {
          "type": "array",
          "description": "A collection of target tag IDs that should be excluded from the deployment. Only deployment targets that have none of these tags will be deployed to. Tag IDs are in the format \"TagSets-{id}/Tags-{id}\".",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ExecutionPlanLogContext": {
          "$ref": "#/definitions/ExecutionPlanLogContext"
        },
        "FailTargetDiscovery": {
          "type": "boolean"
        },
        "FailureEncountered": {
          "type": "boolean"
        },
        "ForcePackageDownload": {
          "type": "boolean"
        },
        "FormValues": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "FrozenRunbookProcessId": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ManifestVariableSetId": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "Priority": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "QueueTime": {
          "type": "string",
          "description": "If set this time will be the used to schedule the deployment to a later time, null is assumed to mean the time will be executed immediately.",
          "format": "date-time"
        },
        "QueueTimeExpiry": {
          "type": "string",
          "format": "date-time"
        },
        "RunbookId": {
          "type": "string",
          "minLength": 1
        },
        "RunbookName": {
          "type": "string"
        },
        "RunbookSnapshotId": {
          "type": "string",
          "minLength": 1
        },
        "SkipActions": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "SpecificMachineIds": {
          "type": "array",
          "description": "A collection of machines in the target environment that should be deployed to. If the collection is empty, all enabled machines are deployed.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "SpecificTargetTagIds": {
          "type": "array",
          "description": "A collection of target tag IDs that should be included in the deployment. Only deployment targets that have at least one of these tags will be deployed to. Tag IDs are in the format \"TagSets-{id}/Tags-{id}\".",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "TaskId": {
          "type": "string",
          "example": "ServerTasks-1"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        },
        "TentacleRetentionPeriod": {
          "$ref": "#/definitions/RetentionPeriod"
        },
        "UseGuidedFailure": {
          "type": "boolean",
          "description": "If set to true, the deployment will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable."
        }
      },
      "additionalProperties": false
    },
    "RunbookRunResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookRunResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "RunbookRunTemplateResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsGitResourceModified": {
          "type": "boolean"
        },
        "IsLibraryVariableSetModified": {
          "type": "boolean"
        },
        "IsRunbookProcessModified": {
          "type": "boolean"
        },
        "IsVariableSetModified": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "PromoteTo": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentPromotionTarget"
          }
        },
        "TenantPromotions": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DeploymentPromotionTenant"
          }
        }
      },
      "additionalProperties": false
    },
    "RunbooksDashboardItemResource": {
      "type": "object",
      "properties": {
        "CompletedTime": {
          "type": "string",
          "format": "date-time"
        },
        "Created": {
          "type": "string",
          "format": "date-time"
        },
        "Duration": {
          "type": "string"
        },
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "ErrorMessage": {
          "type": "string"
        },
        "GitReference": {
          "$ref": "#/definitions/RunbooksDashboardItemResourceGitReference"
        },
        "HasPendingInterruptions": {
          "type": "boolean",
          "readOnly": true
        },
        "HasPendingPreconditions": {
          "type": "boolean",
          "readOnly": true
        },
        "HasWarningsOrErrors": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsCompleted": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "PendingInterruptionTypes": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "ManualIntervention",
              "GuidedFailure",
              "PullRequestCompletion",
              "ArgoCDApplicationSync",
              "KubernetesResourceVerification"
            ]
          }
        },
        "PendingPreconditionTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "QueueTime": {
          "type": "string",
          "format": "date-time"
        },
        "RunbookId": {
          "type": "string"
        },
        "RunbookSnapshotId": {
          "type": "string"
        },
        "RunbookSnapshotName": {
          "type": "string"
        },
        "RunbookSnapshotNotes": {
          "type": "string"
        },
        "RunBy": {
          "type": "string"
        },
        "RunName": {
          "type": "string"
        },
        "StartTime": {
          "type": "string",
          "format": "date-time"
        },
        "State": {
          "type": "string",
          "enum": [
            "Queued",
            "Executing",
            "Failed",
            "Canceled",
            "TimedOut",
            "Success",
            "Cancelling"
          ]
        },
        "TaskId": {
          "type": "string"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        }
      },
      "additionalProperties": false
    },
    "RunbooksDashboardItemResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbooksDashboardItemResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "RunbooksDashboardItemResourceGitReference": {
      "type": "object",
      "properties": {
        "GitCommit": {
          "type": "string"
        },
        "GitRef": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "RunbookSnapshotResource": {
      "type": "object",
      "required": [
        "Assembled",
        "FrozenProjectVariableSetId",
        "FrozenRunbookProcessId",
        "Name",
        "ProjectId",
        "ProjectVariableSetSnapshotId",
        "RunbookId",
        "SpaceId"
      ],
      "properties": {
        "Assembled": {
          "type": "string",
          "format": "date-time"
        },
        "FrozenProjectVariableSetId": {
          "type": "string",
          "minLength": 1
        },
        "FrozenRunbookProcessId": {
          "type": "string",
          "minLength": 1
        },
        "GitReference": {
          "$ref": "#/definitions/SnapshotGitReferenceResource"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LibraryVariableSetSnapshotIds": {
          "type": "array",
          "description": "Snapshots of the project's included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.",
          "items": {
            "type": "string"
          }
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Notes": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ProjectVariableSetSnapshotId": {
          "type": "string",
          "minLength": 1
        },
        "RunbookId": {
          "type": "string",
          "example": "Runbooks-1"
        },
        "SelectedGitResources": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SelectedGitResource"
          }
        },
        "SelectedPackages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SelectedPackage"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "VariableSnapshotConcurrencyToken": {
          "type": "string",
          "description": "Identifies the runbook snapshot's current variable snapshots."
        }
      },
      "additionalProperties": false
    },
    "RunbookSnapshotResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookSnapshotResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "RunbookSnapshotTemplateResource": {
      "type": "object",
      "properties": {
        "GitResources": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseTemplateGitResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NextNameIncrement": {
          "type": "string"
        },
        "Packages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReleaseTemplatePackage"
          }
        },
        "RunbookId": {
          "type": "string"
        },
        "RunbookProcessId": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "RunbookSnapshotUsage": {
      "type": "object",
      "properties": {
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ProjectName": {
          "type": "string"
        },
        "RunbookId": {
          "type": "string"
        },
        "RunbookName": {
          "type": "string"
        },
        "Snapshots": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookSnapshotUsageEntry"
          }
        }
      },
      "additionalProperties": false
    },
    "RunbookSnapshotUsageEntry": {
      "type": "object",
      "properties": {
        "SnapshotId": {
          "type": "string"
        },
        "SnapshotName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "RunbooksProgressionResource": {
      "type": "object",
      "properties": {
        "Environments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "RunbookRuns": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/RunbooksDashboardItemResource"
            }
          }
        }
      },
      "additionalProperties": false
    },
    "RunbookStepUsage": {
      "type": "object",
      "properties": {
        "ProcessId": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string"
        },
        "ProjectName": {
          "type": "string"
        },
        "ProjectSlug": {
          "type": "string"
        },
        "RunbookId": {
          "type": "string"
        },
        "RunbookName": {
          "type": "string"
        },
        "Steps": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/StepUsageEntry"
          }
        }
      },
      "additionalProperties": false
    },
    "RunbookSummary": {
      "type": "object",
      "properties": {
        "RunbookId": {
          "type": "string"
        },
        "RunbookName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "RunGitRunbookCommand": {
      "type": "object",
      "required": [
        "GitRef",
        "ProjectId",
        "RunbookId",
        "Runs",
        "SpaceId"
      ],
      "properties": {
        "GitRef": {
          "type": "string"
        },
        "Notes": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "RunbookId": {
          "type": "string",
          "example": "Runbooks-1"
        },
        "Runs": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunGitRunbookRun"
          }
        },
        "SelectedGitResources": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SelectedGitResource"
          }
        },
        "SelectedPackages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SelectedPackage"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "RunGitRunbookResponse": {
      "type": "object",
      "required": [
        "Resources"
      ],
      "properties": {
        "Resources": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RunbookRunResource"
          }
        }
      },
      "additionalProperties": false
    },
    "RunGitRunbookRun": {
      "type": "object",
      "required": [
        "EnvironmentId"
      ],
      "properties": {
        "ChangeRequestSettings": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ChangeRequestSettings"
          }
        },
        "Comments": {
          "type": "string"
        },
        "DebugMode": {
          "type": "string"
        },
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "ExcludedMachineIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ExcludedTargetTagIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "FailTargetDiscovery": {
          "type": "boolean"
        },
        "ForcePackageDownload": {
          "type": "boolean"
        },
        "FormValues": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Priority": {
          "type": "string"
        },
        "QueueTime": {
          "type": "string",
          "format": "date-time"
        },
        "QueueTimeExpiry": {
          "type": "string",
          "format": "date-time"
        },
        "SkipActions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SpecificMachineIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SpecificTargetTagIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        },
        "UseGuidedFailure": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "RunRunbookCommandV1": {
      "type": "object",
      "required": [
        "RunbookId",
        "SpaceId"
      ],
      "properties": {
        "ChangeRequestSettings": {
          "type": "array",
          "description": "Change Request Settings.",
          "items": {
            "$ref": "#/definitions/ChangeRequestSettings"
          }
        },
        "Comments": {
          "type": "string",
          "description": "Any additional information/context"
        },
        "DebugMode": {
          "type": "string",
          "description": "If set to true contributes the OctopusPrintVariables and OctopusPrintEvaluatedVariables variables to the runbook run"
        },
        "EnvironmentId": {
          "type": "string",
          "description": "Legacy single-environment field; prefer EnvironmentIds. If set, this environment is added to the ones the runbook runs in. At least one of EnvironmentIds or EnvironmentId is required.",
          "example": "Environments-1"
        },
        "EnvironmentIds": {
          "type": "array",
          "description": "The environments to run the runbook in — the preferred way to specify targets, one run per environment. At least one of EnvironmentIds or EnvironmentId is required.",
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "ExcludedMachineIds": {
          "type": "array",
          "description": "A collection of machines in the target environment that should be excluded from the runbook run.",
          "items": {
            "type": "string"
          }
        },
        "ExcludedTargetTagIds": {
          "type": "array",
          "description": "A collection of target tag IDs that should be excluded from the deployment. Only deployment targets that have none of these tags will be deployed to. Tag IDs are in the format \"TagSets-{id}/Tags-{id}\".",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "FailTargetDiscovery": {
          "type": "boolean",
          "description": "Whether to skip or fail cloud discovery steps with no matching target (default false)."
        },
        "ForcePackageDownload": {
          "type": "boolean",
          "description": "Whether to force downloading of already installed packages (flag, default false)."
        },
        "FormValues": {
          "type": "object",
          "description": "Variables",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Priority": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "description": "ID of the project that the runbook belongs to",
          "example": "Projects-1"
        },
        "QueueTime": {
          "type": "string",
          "description": "The time to execute the runbook run",
          "format": "date-time"
        },
        "QueueTimeExpiry": {
          "type": "string",
          "description": "The time at which the runbook run will timeout if it has not started executing.",
          "format": "date-time"
        },
        "RunbookId": {
          "type": "string",
          "description": "ID of the runbook to run",
          "example": "Runbooks-1"
        },
        "RunbookSnapshotNameOrId": {
          "type": "string",
          "description": "Name or ID of a specific snapshot to run. Leave unset to run the published snapshot; when you set this, also set UseDefaultSnapshot to false."
        },
        "SkipActions": {
          "type": "array",
          "description": "Actions that are to be skipped for this runbook.",
          "items": {
            "type": "string"
          }
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s).",
          "example": "Spaces-1"
        },
        "SpecificMachineIds": {
          "type": "array",
          "description": "A collection of machines in the target environment that the runbook should be run on. If the collection is empty, all enabled machines are used.",
          "items": {
            "type": "string"
          }
        },
        "SpecificTargetTagIds": {
          "type": "array",
          "description": "A collection of target tag IDs that should be included in the deployment. Only deployment targets that have at least one of these tags will be deployed to. Tag IDs are in the format \"TagSets-{id}/Tags-{id}\".",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "TenantId": {
          "type": "string",
          "description": "Legacy single-tenant field; prefer TenantIds. If set, this tenant is added to the ones the runbook runs for.",
          "example": "Tenants-1"
        },
        "TenantIds": {
          "type": "array",
          "description": "The tenants to run the runbook for — the preferred way to specify tenants, creating one run per environment/tenant combination. Leave empty for an untenanted run.",
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "TenantTagNames": {
          "type": "array",
          "description": "The tenant tags to filter tenants to run the runbook.",
          "items": {
            "type": "string"
          }
        },
        "UseDefaultSnapshot": {
          "type": "boolean",
          "description": "Whether to run the runbook's published (default) snapshot. Leave true to run the published snapshot; set to false when you name a specific snapshot in RunbookSnapshotNameOrId."
        },
        "UseGuidedFailure": {
          "type": "boolean",
          "description": "If set to true, the runbook will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable."
        }
      },
      "additionalProperties": false
    },
    "RunRunbookServerTask": {
      "type": "object",
      "required": [
        "RunbookRunId",
        "ServerTaskId"
      ],
      "properties": {
        "RunbookRunId": {
          "type": "string",
          "example": "RunbookRuns-1"
        },
        "ServerTaskId": {
          "type": "string",
          "example": "ServerTasks-1"
        }
      },
      "additionalProperties": false
    },
    "ScheduledTaskDetailsResource": {
      "type": "object",
      "properties": {
        "ActivityLog": {
          "$ref": "#/definitions/ActivityLogTreeNode"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "ScheduledTaskStatusResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsEnabled": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "SchedulerStatusResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsRunning": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "TaskStatus": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ScheduledTaskStatusResource"
          }
        }
      },
      "additionalProperties": false
    },
    "ScopedUserRoleResource": {
      "type": "object",
      "properties": {
        "EnvironmentIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectGroupIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "ProjectIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Projects-1",
            "..."
          ]
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TeamId": {
          "type": "string"
        },
        "TenantIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "UserRoleId": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ScopedUserRoleResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ScopedUserRoleResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "SearchExternalAuthenticationProvidersResponse": {
      "type": "object",
      "required": [
        "Links",
        "Results"
      ],
      "properties": {
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Results": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ExternalUserLookupResult"
          }
        }
      },
      "additionalProperties": false
    },
    "SelectedGitResource": {
      "type": "object",
      "required": [
        "ActionName",
        "GitReferenceResource"
      ],
      "properties": {
        "ActionName": {
          "type": "string",
          "minLength": 1
        },
        "GitReferenceResource": {
          "$ref": "#/definitions/GitReferenceResource"
        },
        "GitResourceReferenceName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "SelectedPackage": {
      "type": "object",
      "properties": {
        "ActionName": {
          "type": "string"
        },
        "PackageReferenceName": {
          "type": "string"
        },
        "StepName": {
          "type": "string"
        },
        "Version": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "SemanticVersion": {
      "type": "object",
      "properties": {
        "Format": {
          "type": "string",
          "enum": [
            "Semver",
            "Maven",
            "Docker",
            "Octopus",
            "Lexicographic"
          ],
          "readOnly": true
        },
        "HasMetadata": {
          "type": "boolean",
          "readOnly": true
        },
        "IsLegacyVersion": {
          "type": "boolean",
          "readOnly": true
        },
        "IsPrerelease": {
          "type": "boolean",
          "readOnly": true
        },
        "IsSemVer2": {
          "type": "boolean",
          "readOnly": true
        },
        "Major": {
          "type": "integer",
          "format": "int32"
        },
        "Metadata": {
          "type": "string"
        },
        "Minor": {
          "type": "integer",
          "format": "int32"
        },
        "OriginalString": {
          "type": "string",
          "readOnly": true
        },
        "Patch": {
          "type": "integer",
          "format": "int32"
        },
        "Release": {
          "type": "string",
          "readOnly": true
        },
        "ReleaseLabels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Revision": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Version": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "SensitiveValue": {
      "type": "object",
      "properties": {
        "HasValue": {
          "type": "boolean"
        },
        "Hint": {
          "type": "string"
        },
        "NewValue": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ServerConfigurationResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ServerUri": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ServerConfigurationSettingsResource": {
      "type": "object",
      "properties": {
        "ConfigurationSet": {
          "type": "string"
        },
        "ConfigurationValues": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ServerConfigurationValueResource"
          }
        }
      },
      "additionalProperties": false
    },
    "ServerConfigurationValueResource": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "Key": {
          "type": "string"
        },
        "Value": { }
      },
      "additionalProperties": false
    },
    "ServerDocumentCounts": {
      "type": "object",
      "properties": {
        "Global": {
          "$ref": "#/definitions/GlobalDocumentCounts"
        },
        "Infrastructure": {
          "$ref": "#/definitions/InfrastructureDocumentCounts"
        },
        "Library": {
          "$ref": "#/definitions/LibraryDocumentCounts"
        },
        "Project": {
          "$ref": "#/definitions/ProjectDocumentCounts"
        }
      },
      "additionalProperties": false
    },
    "ServerStatusHealthResource": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsCompliantWithLicense": {
          "type": "boolean"
        },
        "IsEntireClusterDrainingTasks": {
          "type": "boolean"
        },
        "IsEntireClusterReadOnly": {
          "type": "boolean"
        },
        "IsOperatingNormally": {
          "type": "boolean",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "ServerStatusResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDatabaseEncrypted": {
          "type": "boolean"
        },
        "IsInMaintenanceMode": {
          "type": "boolean"
        },
        "IsMajorMinorUpgrade": {
          "type": "boolean"
        },
        "IsPotentialClone": {
          "type": "boolean"
        },
        "IsUpgradeAvailable": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "MaintenanceExpires": {
          "type": "string"
        },
        "MaximumAvailableVersion": {
          "type": "string"
        },
        "MaximumAvailableVersionCoveredByLicense": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ServerTaskApprovalResource": {
      "type": "object",
      "required": [
        "ApprovalProviderId",
        "ChangeRequest",
        "Id",
        "Name",
        "ServerTaskId",
        "SpaceId"
      ],
      "properties": {
        "ApprovalProviderId": {
          "type": "string"
        },
        "ChangeRequest": {
          "$ref": "#/definitions/ChangeResource"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ServerTaskId": {
          "type": "string",
          "example": "ServerTasks-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ServerTaskApprovalResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ServerTaskApprovalResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ServerTaskStatusMessageResource": {
      "type": "object",
      "properties": {
        "Category": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Message": {
          "type": "string"
        },
        "Title": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ServerTimezoneResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsLocal": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ServiceAccountOidcIdentityResource": {
      "type": "object",
      "required": [
        "Id",
        "Issuer",
        "Name",
        "ServiceAccountId",
        "Subject"
      ],
      "properties": {
        "Audience": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "Issuer": {
          "type": "string",
          "minLength": 1
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "ServiceAccountId": {
          "type": "string",
          "example": "Users-1"
        },
        "Subject": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ServiceNowConnectionCheckRequest": {
      "type": "object",
      "properties": {
        "BaseUrl": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "OAuthClientId": {
          "type": "string"
        },
        "OAuthClientSecret": {
          "type": "string"
        },
        "Username": {
          "type": "string"
        },
        "UserPassword": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "SetConnectionAgentForwardingRuleCommand": {
      "type": "object",
      "required": [
        "ConnectionAgentName",
        "Fqdn",
        "IgnoreCertificateValidationErrors"
      ],
      "properties": {
        "ConnectionAgentName": {
          "type": "string",
          "description": "The name of the Connection Agent that matched requests will be forwarded to."
        },
        "Fqdn": {
          "type": "string",
          "description": "The fully qualified domain name to match against incoming requests.",
          "maxLength": 253,
          "minLength": 1
        },
        "IgnoreCertificateValidationErrors": {
          "type": "boolean",
          "description": "Whether to ignore certificate validation errors from requests to the FQDN"
        }
      },
      "additionalProperties": false
    },
    "SetDynamicExtensionsFeaturesValuesCommand": {
      "type": "object",
      "required": [
        "Values"
      ],
      "properties": {
        "Values": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "SetPerformanceConfigurationCommand": {
      "type": "object",
      "required": [
        "DefaultDashboardRenderMode"
      ],
      "properties": {
        "DefaultDashboardRenderMode": {
          "type": "string",
          "enum": [
            "VirtualizeColumns",
            "VirtualizeRowsAndColumns"
          ]
        }
      },
      "additionalProperties": false
    },
    "SetServerConfigurationCommand": {
      "type": "object",
      "required": [
        "ServerUri"
      ],
      "properties": {
        "ServerUri": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "SetSigningKeyConfigurationCommand": {
      "type": "object",
      "required": [
        "ExpireAfterDays",
        "RevokeAfterDays"
      ],
      "properties": {
        "ExpireAfterDays": {
          "type": "integer",
          "format": "int32",
          "maximum": 365,
          "minimum": 1
        },
        "PublicKeyHostingLocation": {
          "type": "string",
          "enum": [
            "Internal",
            "External"
          ]
        },
        "RevokeAfterDays": {
          "type": "integer",
          "format": "int32",
          "maximum": 365,
          "minimum": 1
        }
      },
      "additionalProperties": false
    },
    "SetUpgradeConfigurationCommand": {
      "type": "object",
      "required": [
        "AllowChecking",
        "IncludeStatistics",
        "NotificationMode"
      ],
      "properties": {
        "AllowChecking": {
          "type": "boolean",
          "description": "Whether to check octopus.com to see if a new version is available."
        },
        "IncludeStatistics": {
          "type": "boolean",
          "description": "Deprecated: please use the [dedicated telemetry page](https://oc.to/telemetry) to determine whether octopus sends usage statistics. See [our documentation](https://oc.to/WhatIsIncludedInUsageStatistics) for information about what is included."
        },
        "NotificationMode": {
          "type": "string",
          "description": "Controls which notifications are shown in the portal when an upgrade is available.",
          "enum": [
            "AlwaysShow",
            "ShowOnlyMajorMinor",
            "NeverShow"
          ]
        }
      },
      "additionalProperties": false
    },
    "ShareProcessTemplateCommand": {
      "type": "object",
      "required": [
        "GitRef",
        "IndividuallySharedSpaceIds",
        "ShareToAllSpaces",
        "Slug"
      ],
      "properties": {
        "GitRef": {
          "type": "string"
        },
        "IndividuallySharedSpaceIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Spaces-1",
            "..."
          ]
        },
        "ShareToAllSpaces": {
          "type": "boolean"
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ShareProcessTemplateResponse": {
      "type": "object",
      "required": [
        "IndividuallySharedSpaceIds",
        "IndividuallyUnsharedSpaceIds",
        "SharedToAllSpaces"
      ],
      "properties": {
        "IndividuallySharedSpaceIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Spaces-1",
            "..."
          ]
        },
        "IndividuallyUnsharedSpaceIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Spaces-1",
            "..."
          ]
        },
        "SharedToAllSpaces": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "ShareProjectTemplateCommand": {
      "type": "object",
      "required": [
        "GitRef",
        "IndividuallySharedSpaceIds",
        "ShareToAllSpaces",
        "Slug"
      ],
      "properties": {
        "GitRef": {
          "type": "string"
        },
        "IndividuallySharedSpaceIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Spaces-1",
            "..."
          ]
        },
        "ShareToAllSpaces": {
          "type": "boolean"
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ShareProjectTemplateResponse": {
      "type": "object",
      "required": [
        "IndividuallySharedSpaceIds",
        "IndividuallyUnsharedSpaceIds",
        "SharedToAllSpaces"
      ],
      "properties": {
        "IndividuallySharedSpaceIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Spaces-1",
            "..."
          ]
        },
        "IndividuallyUnsharedSpaceIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "Spaces-1",
            "..."
          ]
        },
        "SharedToAllSpaces": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "SigningKeyConfigurationResource": {
      "type": "object",
      "properties": {
        "ExpireAfterDays": {
          "type": "integer",
          "format": "int32"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "PublicKeyHostingLocation": {
          "type": "string",
          "enum": [
            "Internal",
            "External"
          ]
        },
        "RevokeAfterDays": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "SmtpConfigurationResource": {
      "type": "object",
      "properties": {
        "Details": {
          "$ref": "#/definitions/SmtpCredentialDetailsResource"
        },
        "EnableSsl": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "SendEmailFrom": {
          "type": "string"
        },
        "SmtpHost": {
          "type": "string"
        },
        "SmtpPort": {
          "type": "number",
          "maximum": 65535,
          "minimum": 0
        },
        "Timeout": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "SmtpCredentialDetailsResource": {
      "type": "object",
      "properties": {
        "CredentialType": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "SmtpIsConfiguredResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsConfigured": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "SnapshotGitReferenceResource": {
      "type": "object",
      "properties": {
        "GitCommit": {
          "type": "string"
        },
        "GitRef": {
          "type": "string"
        },
        "VariablesGitCommit": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "SpaceDefaultRetentionPolicyResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "readOnly": true
        },
        "Name": {
          "type": "string",
          "readOnly": true
        },
        "RetentionType": {
          "type": "string",
          "readOnly": true,
          "example": "LifecycleRelease"
        },
        "SpaceId": {
          "type": "string",
          "readOnly": true,
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "SpaceLicenseUsageResource": {
      "type": "object",
      "properties": {
        "MachinesCount": {
          "type": "integer",
          "format": "int32"
        },
        "ProjectsCount": {
          "type": "integer",
          "format": "int32"
        },
        "SpaceName": {
          "type": "string"
        },
        "TenantsCount": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "SpaceResource": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "ExtensionSettings": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ExtensionSettingsValues"
          },
          "readOnly": true
        },
        "Icon": {
          "$ref": "#/definitions/IconResource"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDefault": {
          "type": "boolean"
        },
        "IsPrivate": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "Slug": {
          "type": "string"
        },
        "SpaceManagersTeamMembers": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Users-1",
            "..."
          ]
        },
        "SpaceManagersTeams": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "TaskQueueStopped": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "SpaceResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SpaceResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "SpaceRootResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "SpaceSearchResult": {
      "type": "object",
      "required": [
        "Id",
        "Name",
        "Type"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "minLength": 1
        },
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Owner": {
          "$ref": "#/definitions/SpaceSearchResultOwner"
        },
        "Type": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "SpaceSearchResultOwner": {
      "type": "object",
      "required": [
        "Name",
        "Type"
      ],
      "properties": {
        "Name": {
          "type": "string",
          "minLength": 1
        },
        "Type": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "SshKnownHostResource": {
      "type": "object",
      "properties": {
        "Host": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "example": "SshKnownHosts-1"
        },
        "KeyType": {
          "type": "string"
        },
        "PublicKey": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "StepLogContext": {
      "type": "object",
      "required": [
        "CorrelationId",
        "Slug"
      ],
      "properties": {
        "CorrelationId": {
          "type": "string",
          "example": "0c5a872485ac4b10857939a92d082e67"
        },
        "Slug": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "StepPackageInputsResource": {
      "type": "object",
      "properties": {
        "Value": { }
      },
      "additionalProperties": false
    },
    "StepUsage": {
      "type": "object",
      "properties": {
        "ProjectId": {
          "type": "string"
        },
        "ProjectName": {
          "type": "string"
        },
        "ProjectSlug": {
          "type": "string"
        },
        "Steps": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/StepUsageEntry"
          }
        }
      },
      "additionalProperties": false
    },
    "StepUsageEntry": {
      "type": "object",
      "properties": {
        "StepId": {
          "type": "string"
        },
        "StepName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "StringStringKeyValuePair": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string"
        },
        "Value": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "SubmitInterruptionCommand": {
      "type": "object",
      "required": [
        "Id",
        "SpaceId"
      ],
      "properties": {
        "Guidance": {
          "type": "string",
          "description": "Used for Guided Failure Interruptions. Should be one of \"Fail\", \"Retry\", \"Ignore\" or \"Exclude\""
        },
        "Id": {
          "type": "string",
          "description": "ID of the Interruption",
          "minLength": 1
        },
        "Instructions": {
          "type": "string",
          "description": "Optional free-text instructions recorded with the submission."
        },
        "Notes": {
          "type": "string",
          "description": "Optional notes recorded with the submission and included in the audit log entry."
        },
        "Result": {
          "type": "string",
          "description": "Used for Manual Intervention Interruptions. Should be one of \"Proceed\" or \"Abort\""
        },
        "SpaceId": {
          "type": "string",
          "description": "ID of the Space",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "SubscriptionResource": {
      "type": "object",
      "properties": {
        "EventNotificationSubscription": {
          "$ref": "#/definitions/EventNotificationSubscriptionResource"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Type": {
          "type": "string",
          "enum": [
            "Event"
          ]
        }
      },
      "additionalProperties": false
    },
    "SubscriptionResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SubscriptionResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "SystemInfoResource": {
      "type": "object",
      "properties": {
        "ClrVersion": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "MinThreadPoolCount": {
          "type": "integer",
          "format": "int32"
        },
        "OSVersion": {
          "type": "string"
        },
        "ThreadCount": {
          "type": "integer",
          "format": "int32"
        },
        "Uptime": {
          "type": "string",
          "format": "date-span"
        },
        "Version": {
          "type": "string"
        },
        "WorkingSetBytes": {
          "type": "integer",
          "format": "int64"
        }
      },
      "additionalProperties": false
    },
    "TagResource": {
      "type": "object",
      "properties": {
        "CanonicalTagName": {
          "type": "string",
          "description": "This is the canonical name for the Tag formed as {TagSetName}/{TagName} which is easier to work with than the ID in certain scenarios."
        },
        "Color": {
          "type": "string",
          "description": "Gets or sets the color of this tag."
        },
        "Description": {
          "type": "string",
          "description": "Gets or sets the description of this tag."
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string",
          "description": "Gets or sets the name of this tag."
        },
        "SortOrder": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "TagSetPreview": {
      "type": "object",
      "required": [
        "TagSetId",
        "TagSetName",
        "TagSetType"
      ],
      "properties": {
        "AvailableTags": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TargetTagPreview"
          }
        },
        "SortOrder": {
          "type": "integer",
          "format": "int32"
        },
        "TagSetId": {
          "type": "string",
          "minLength": 1
        },
        "TagSetName": {
          "type": "string",
          "minLength": 1
        },
        "TagSetType": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "TagSetResource": {
      "type": "object",
      "required": [
        "Name"
      ],
      "properties": {
        "Description": {
          "type": "string",
          "description": "Gets or sets the description of this tag set."
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsSystem": {
          "type": "boolean",
          "description": "Whether this tag set is a system-managed tag set."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "description": "Gets or sets the name of this tag set.",
          "minLength": 1
        },
        "Scopes": {
          "type": "array",
          "description": "The resource types this tag set applies to.",
          "items": {
            "type": "string"
          }
        },
        "SortOrder": {
          "type": "integer",
          "description": "Gets or sets the sort order of this tag set.",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Tags": {
          "type": "array",
          "description": "The tags that make up this tag set",
          "items": {
            "$ref": "#/definitions/TagResource"
          }
        },
        "Type": {
          "type": "string",
          "description": "The type of this tag set."
        }
      },
      "additionalProperties": false
    },
    "TagSetResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TagSetResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "TagTestResult": {
      "type": "object",
      "properties": {
        "IsDisabled": {
          "type": "boolean"
        },
        "IsMatched": {
          "type": "boolean"
        },
        "MissingTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Reason": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "TargetTagPreview": {
      "type": "object",
      "required": [
        "TagId",
        "TagName"
      ],
      "properties": {
        "SortOrder": {
          "type": "integer",
          "format": "int32"
        },
        "TagId": {
          "type": "string",
          "minLength": 1
        },
        "TagName": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "TargetUsageEntry": {
      "type": "object",
      "properties": {
        "TargetId": {
          "type": "string"
        },
        "TargetName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "TaskDetailsResource": {
      "type": "object",
      "properties": {
        "ActivityLogs": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ActivityLogTreeNode"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "PhysicalLogSize": {
          "type": "integer",
          "format": "int64"
        },
        "Progress": {
          "$ref": "#/definitions/TaskProgress"
        },
        "Task": {
          "$ref": "#/definitions/TaskResource"
        }
      },
      "additionalProperties": false
    },
    "TaskProgress": {
      "type": "object",
      "properties": {
        "EstimatedTimeRemaining": {
          "type": "string"
        },
        "ProgressPercentage": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "TaskResource": {
      "type": "object",
      "properties": {
        "Arguments": {
          "type": "object",
          "description": "Gets or sets any arguments to the task.",
          "additionalProperties": { }
        },
        "CanRerun": {
          "type": "boolean",
          "description": "If true, then the task can be used as the basis for a new task with the same effect."
        },
        "Completed": {
          "type": "string",
          "description": "Gets or sets a value indicating the completion status of the task. May be \"Timed out\", \"Queued...\", \"Executing...\", or the time at which the task completed for completed tasks."
        },
        "CompletedTime": {
          "type": "string",
          "description": "Gets or sets the date/time that the task completed. Will be null if the task has not yet completed.",
          "format": "date-time"
        },
        "Description": {
          "type": "string",
          "description": "Gets or sets a short, human-understandable description of this task. An example might be \"Manual database backup\". This is the name that will be shown in the task list."
        },
        "Duration": {
          "type": "string",
          "description": "Gets or sets a string indicating how long the task took to run."
        },
        "ErrorMessage": {
          "type": "string",
          "description": "Gets or sets a short summary of the errors encountered when the task ran (if any)."
        },
        "EstimatedRemainingQueueDurationSeconds": {
          "type": "integer",
          "format": "int32"
        },
        "FinishedSuccessfully": {
          "type": "boolean",
          "description": "Gets or sets a value indicating whether the task ran to completion successfully.",
          "readOnly": true
        },
        "HasBeenPickedUpByProcessor": {
          "type": "boolean",
          "description": "Gets or sets a boolean value indicating whether the Octopus Server is processing this task."
        },
        "HasPendingInterruptions": {
          "type": "boolean",
          "description": "True if the task has any pending interruptions.",
          "readOnly": true
        },
        "HasPendingPreconditions": {
          "type": "boolean",
          "description": "True if the task has any pending preconditions.",
          "readOnly": true
        },
        "HasWarningsOrErrors": {
          "type": "boolean",
          "description": "True if any warnings or non-fatal errors were recorded in the task log during execution."
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsCompleted": {
          "type": "boolean",
          "description": "Gets or sets a value indicating whether the task has completed (that is, not queued, not running, and not paused; may have finished successfully or failed).",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastUpdatedTime": {
          "type": "string",
          "description": "Gets or sets the time that the Octopus server last updated the status of this task. For a running task this should happen at least every couple of minutes.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "description": "Gets or sets the name of the task to create. This name must be one of the list of possible names documented in the create API operation documentation."
        },
        "PendingInterruptionTypes": {
          "type": "array",
          "description": "Contains a list of the types of any pending interruptions",
          "items": {
            "type": "string",
            "enum": [
              "ManualIntervention",
              "GuidedFailure",
              "PullRequestCompletion",
              "ArgoCDApplicationSync",
              "KubernetesResourceVerification"
            ]
          }
        },
        "PendingPreconditionTypes": {
          "type": "array",
          "description": "Contains a list of the types of any pending preconditions",
          "items": {
            "type": "string"
          }
        },
        "ProjectId": {
          "type": "string",
          "description": "If the task belongs to a project (e.g. a deployment), the ID of the project it belongs to",
          "example": "Projects-1"
        },
        "QueueTime": {
          "type": "string",
          "description": "Gets or sets the time at which the task was queued.",
          "format": "date-time"
        },
        "QueueTimeExpiry": {
          "type": "string",
          "description": "Gets or sets the time at which the task will timeout if it has not started executing.",
          "format": "date-time"
        },
        "ServerNode": {
          "type": "string",
          "description": "Gets the ID of the Octopus server that created and will control this task."
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "StartTime": {
          "type": "string",
          "description": "Gets or sets the time at which the task started executing.",
          "format": "date-time"
        },
        "State": {
          "type": "string",
          "description": "Gets or sets the current state of the task.",
          "enum": [
            "Queued",
            "Executing",
            "Failed",
            "Canceled",
            "TimedOut",
            "Success",
            "Cancelling"
          ]
        }
      },
      "additionalProperties": false
    },
    "TaskResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TaskResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "TaskTypeResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string"
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "TeamMembership": {
      "type": "object",
      "properties": {
        "ExternalSecurityGroups": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/NamedReferenceItem"
          }
        },
        "IsDirectlyAssigned": {
          "type": "boolean"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TeamId": {
          "type": "string"
        },
        "TeamName": {
          "type": "string"
        },
        "UserId": {
          "type": "string",
          "example": "Users-1"
        }
      },
      "additionalProperties": false
    },
    "TeamMembershipPreview": {
      "type": "object",
      "properties": {
        "ExternalSecurityGroups": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/NamedReferenceItem"
          }
        },
        "IsDirectlyAssigned": {
          "type": "boolean"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TeamId": {
          "type": "string",
          "example": "Teams-1"
        },
        "TeamName": {
          "type": "string"
        },
        "UserId": {
          "type": "string",
          "example": "Users-1"
        }
      },
      "additionalProperties": false
    },
    "TeamResource": {
      "type": "object",
      "properties": {
        "CanBeDeleted": {
          "type": "boolean",
          "description": "Gets or sets a flag indicating whether the team can be deleted. The built-in teams provided by Octopus generally cannot be deleted."
        },
        "CanBeRenamed": {
          "type": "boolean",
          "description": "Gets or sets a flag indicating whether the team can be renamed. The built-in teams provided by Octopus generally cannot be renamed."
        },
        "CanChangeMembers": {
          "type": "boolean",
          "description": "Gets or sets a flag indicating whether the members of this team can be changed. The built-in Everyone team provided by Octopus cannot have its members changed, as it will always contain all users."
        },
        "CanChangeRoles": {
          "type": "boolean",
          "description": "Gets or sets a flag indicating whether the team's roles can be changed. The built-in Octopus Administrators team provided by Octopus cannot have its roles modified; all other teams can."
        },
        "Description": {
          "type": "string"
        },
        "ExternalSecurityGroups": {
          "type": "array",
          "description": "The externally-managed security groups (e.g., Active Directory groups) who belong to the team.",
          "items": {
            "$ref": "#/definitions/NamedReferenceItem"
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "MemberUserIds": {
          "type": "array",
          "description": "The users who belong to the team.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Users-1",
            "..."
          ]
        },
        "Name": {
          "type": "string",
          "description": "Gets or sets the name of this team."
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "TeamResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TeamResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "TelemetryConfigurationResource": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsTelemetryEnforced": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ShowAsNewUntil": {
          "type": "string",
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "TemplateParameterValueResource": {
      "type": "object",
      "required": [
        "Scope",
        "Value"
      ],
      "properties": {
        "Scope": {
          "type": "object",
          "properties": {
            "Project": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Environment": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Machine": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Role": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "TargetRole": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Action": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "User": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Trigger": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "ParentDeployment": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Private": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Channel": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "TenantTag": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Tenant": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "ProcessOwner": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "ProjectTemplate": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "TemplatedProject": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "ProcessTemplateStep": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "EnvironmentParameter": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "TargetTagParameter": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "TenantTagParameter": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            }
          },
          "additionalProperties": false
        },
        "Value": {
          "$ref": "#/definitions/PropertyValueResource"
        }
      },
      "additionalProperties": false
    },
    "TenantCommonVariablePayload": {
      "type": "object",
      "required": [
        "OwnerId",
        "Scope",
        "TemplateId",
        "Value"
      ],
      "properties": {
        "Id": {
          "type": "string"
        },
        "OwnerId": {
          "type": "string",
          "minLength": 1
        },
        "Scope": {
          "$ref": "#/definitions/ITenantVariableScope"
        },
        "TemplateId": {
          "type": "string",
          "minLength": 1
        },
        "Value": {
          "$ref": "#/definitions/PropertyValueResource"
        }
      },
      "additionalProperties": false
    },
    "TenantCommonVariableV2": {
      "type": "object",
      "required": [
        "Id",
        "LibraryVariableSetId",
        "Scope",
        "TemplateId",
        "Value"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "minLength": 1
        },
        "LibraryVariableSetId": {
          "type": "string",
          "example": "LibraryVariableSets-1"
        },
        "LibraryVariableSetName": {
          "type": "string"
        },
        "Scope": {
          "$ref": "#/definitions/CommonVariableScope"
        },
        "Template": {
          "$ref": "#/definitions/ActionTemplateParameterResource"
        },
        "TemplateId": {
          "type": "string",
          "minLength": 1
        },
        "Value": {
          "$ref": "#/definitions/PropertyValueResource"
        }
      },
      "additionalProperties": false
    },
    "TenantProjectEnvironment": {
      "type": "object",
      "required": [
        "EnvironmentId",
        "ProjectId",
        "TenantId"
      ],
      "properties": {
        "EnvironmentId": {
          "type": "string",
          "example": "Environments-1"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        }
      },
      "additionalProperties": false
    },
    "TenantProjectVariablePayload": {
      "type": "object",
      "required": [
        "OwnerId",
        "Scope",
        "TemplateId",
        "Value"
      ],
      "properties": {
        "Id": {
          "type": "string"
        },
        "OwnerId": {
          "type": "string",
          "minLength": 1
        },
        "Scope": {
          "$ref": "#/definitions/ITenantVariableScope"
        },
        "TemplateId": {
          "type": "string",
          "minLength": 1
        },
        "Value": {
          "$ref": "#/definitions/PropertyValueResource"
        }
      },
      "additionalProperties": false
    },
    "TenantProjectVariableV2": {
      "type": "object",
      "required": [
        "Id",
        "ProjectId",
        "Scope",
        "TemplateId",
        "Value"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "minLength": 1
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "ProjectName": {
          "type": "string"
        },
        "Scope": {
          "$ref": "#/definitions/ProjectVariableScope"
        },
        "Template": {
          "$ref": "#/definitions/ActionTemplateParameterResource"
        },
        "TemplateId": {
          "type": "string",
          "minLength": 1
        },
        "Value": {
          "$ref": "#/definitions/PropertyValueResource"
        }
      },
      "additionalProperties": false
    },
    "TenantResource": {
      "type": "object",
      "properties": {
        "ClonedFromTenantId": {
          "type": "string"
        },
        "CustomFields": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "Description": {
          "type": "string"
        },
        "Icon": {
          "$ref": "#/definitions/IconResource"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "ProjectEnvironments": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          }
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantTags": {
          "type": "array",
          "description": "Tags are referenced by CanonicalName like {TagSetName}/{TagName}",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "TenantResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TenantResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "TenantsMissingVariablesResource": {
      "type": "object",
      "properties": {
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "readOnly": true
        },
        "MissingVariables": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/MissingVariableResource"
          }
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        }
      },
      "additionalProperties": false
    },
    "TenantVariableResource": {
      "type": "object",
      "properties": {
        "ConcurrencyToken": {
          "type": "string"
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LibraryVariables": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/Library"
          }
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "ProjectVariables": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/Project"
          }
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TenantId": {
          "type": "string",
          "example": "Tenants-1"
        },
        "TenantName": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "TestChannelVersionRulesResponse": {
      "type": "object",
      "required": [
        "Errors",
        "SatisfiesPreReleaseTag",
        "SatisfiesVersionRange"
      ],
      "properties": {
        "Errors": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SatisfiesPreReleaseTag": {
          "type": "boolean"
        },
        "SatisfiesVersionRange": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "TestChannelVersionRulesResponseV1": {
      "type": "object",
      "required": [
        "Errors",
        "SatisfiesPreReleaseTag",
        "SatisfiesVersionRange",
        "SatisfiesVersionTagRegex"
      ],
      "properties": {
        "Errors": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SatisfiesPreReleaseTag": {
          "type": "boolean"
        },
        "SatisfiesVersionRange": {
          "type": "boolean"
        },
        "SatisfiesVersionTagRegex": {
          "type": "boolean",
          "description": "Whether the version satisfies the rule's version-tag regex. Defaults to true (no regex, or a legacy caller, counts as satisfied)."
        }
      },
      "additionalProperties": false
    },
    "TestGitSettingsCommand": {
      "type": "object",
      "required": [
        "BasePath",
        "Credentials",
        "DefaultBranch",
        "ProjectId",
        "SpaceId",
        "Url"
      ],
      "properties": {
        "BasePath": {
          "type": "string"
        },
        "Credentials": {
          "$ref": "#/definitions/GitCredentialUsageResource"
        },
        "DefaultBranch": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Url": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "TestGitSettingsResponse": {
      "type": "object",
      "required": [
        "Messages"
      ],
      "properties": {
        "Messages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GitSettingsTestMessage"
          }
        }
      },
      "additionalProperties": false
    },
    "ToggleDeprecationCommand": {
      "type": "object",
      "required": [
        "Deprecation",
        "Enabled"
      ],
      "properties": {
        "Deprecation": {
          "type": "string",
          "minLength": 1
        },
        "Enabled": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "ToggleDeprecationResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "TriggerActionResource": {
      "type": "object",
      "properties": {
        "ActionType": {
          "type": "string",
          "enum": [
            "AutoDeploy",
            "DeployLatestRelease",
            "DeployNewRelease",
            "DeployLatestReleaseToEnvironment",
            "RunRunbook",
            "CreateRelease"
          ],
          "readOnly": true
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "TriggerFilterResource": {
      "type": "object",
      "properties": {
        "FilterType": {
          "type": "string",
          "enum": [
            "MachineFilter",
            "DailySchedule",
            "DaysPerWeekSchedule",
            "DaysPerMonthSchedule",
            "CronExpressionSchedule",
            "OnceDailySchedule",
            "ContinuousDailySchedule",
            "FeedFilter",
            "ArcFeedFilter",
            "GitFilter",
            "WebhookFilter"
          ],
          "readOnly": true
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "TriggerGarbageCollectionResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "TypeMetadata": {
      "type": "object",
      "properties": {
        "Name": {
          "type": "string"
        },
        "Properties": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PropertyMetadata"
          }
        }
      },
      "additionalProperties": false
    },
    "UnarchiveCertificateResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "UnarchivePlatformHubCertificateResponse": {
      "type": "object",
      "additionalProperties": false
    },
    "UpdateActionTemplateActionsCommand": {
      "type": "object",
      "required": [
        "ActionsToUpdate",
        "Id",
        "SpaceId",
        "Version"
      ],
      "properties": {
        "ActionIdsByProcessId": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "ActionsToUpdate": {
          "type": "array",
          "description": "The actions to be updated to match the action template.",
          "items": {
            "$ref": "#/definitions/ActionsUpdateProcessResource"
          }
        },
        "DefaultPropertyValues": {
          "type": "object",
          "description": "Default values for properties of the action template.",
          "additionalProperties": {
            "$ref": "#/definitions/PropertyValueResource"
          }
        },
        "Id": {
          "type": "string",
          "description": "The ID of the Action Template.",
          "example": "ActionTemplates-1"
        },
        "Overrides": {
          "type": "object",
          "description": "Overrides for values of the properties of the action template.",
          "additionalProperties": {
            "$ref": "#/definitions/PropertyValueResource"
          }
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the Space containing the Action Template.",
          "example": "Spaces-1"
        },
        "Version": {
          "type": "integer",
          "description": "The version of the Action Template.",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "UpdateFeaturesConfigurationCommand": {
      "type": "object",
      "description": "Updates the features configuration of the current instance",
      "properties": {
        "DefaultPowerShellEdition": {
          "type": "string",
          "description": "Default PowerShell edition for deployments and runbooks."
        },
        "HelpSidebarSupportLink": {
          "type": "string",
          "description": "Enable help sidebar support link feature."
        },
        "HelpSidebarSupportLinkLabel": {
          "type": "string",
          "description": "Custom label for the help sidebar support link"
        },
        "Id": {
          "type": "string",
          "description": "The id of features configuration resource."
        },
        "IsAutomaticStepUpdatesEnabled": {
          "type": "boolean",
          "description": "Enable automatic step updates feature."
        },
        "IsBuiltInWorkerEnabled": {
          "type": "boolean",
          "description": "Enable built-in worker feature."
        },
        "IsCommunityActionTemplatesEnabled": {
          "type": "boolean",
          "description": "Enable community action templates feature."
        },
        "IsCompositeDockerHubRegistryFeedEnabled": {
          "type": "boolean",
          "description": "Enable composite DockerHub registry feed feature."
        },
        "IsConfigureFeedsWithLocalOrSmbPathsEnabled": {
          "type": "boolean",
          "description": "Enable local or SMB paths for feeds feature."
        },
        "IsExperimentalUIFeatureEnabled": {
          "type": "boolean",
          "description": "Enable experimental UI feature."
        },
        "IsGitHubAppEnabled": {
          "type": "boolean",
          "description": "Enable the Octopus Deploy GitHub App"
        },
        "IsHelpSidebarEnabled": {
          "type": "boolean",
          "description": "Enable help sidebar feature."
        },
        "IsKubernetesCloudTargetDiscoveryEnabled": {
          "type": "boolean",
          "description": "Enable Kubernetes cloud target discovery feature."
        },
        "IsNavigationVisualUpliftEnabled": {
          "type": "boolean",
          "description": "Enable navigation visual uplift feature."
        },
        "IsProjectsPageOnboardingEnabled": {
          "type": "boolean",
          "description": "Enable projects page onboarding experience"
        },
        "IsProjectsPageOptimizationEnabled": {
          "type": "boolean",
          "description": "Enable new project page bff datasource"
        },
        "IsWebhookTriggerEnabled": {
          "type": "boolean",
          "description": "Enable the webhook triggers feature."
        }
      },
      "additionalProperties": false
    },
    "UpdateReleaseNotesCommand": {
      "type": "object",
      "description": "Only the release notes are changed and everything else about the Release is left alone. Variable expressions in the notes are evaluated before they are stored, so the saved text is the resolved one.",
      "required": [
        "ReleaseId",
        "ReleaseNotes",
        "SpaceId"
      ],
      "properties": {
        "ReleaseId": {
          "type": "string",
          "description": "The ID of the release, for example 'Releases-123'.",
          "example": "Releases-1"
        },
        "ReleaseNotes": {
          "type": "string",
          "description": "The notes to store, replacing whatever the release currently has. Markdown is supported. Build information is in scope, so expressions such as #{Octopus.Release.WorkItems} and #{Octopus.Release.Number} are resolved before the notes are saved. Send an empty string to clear them."
        },
        "SpaceId": {
          "type": "string",
          "description": "The ID of the space containing the resource(s)",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "UpdateReleaseVariablesSnapshotCommandV1": {
      "type": "object",
      "required": [
        "ReleaseId",
        "SpaceId"
      ],
      "properties": {
        "ReleaseId": {
          "type": "string",
          "example": "Releases-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "VariableSnapshotConcurrencyToken": {
          "type": "string",
          "description": "The VariableSnapshotConcurrencyToken read from the release. When supplied, the update fails with a conflict if the release's variable snapshots have changed since. Omit to skip the check."
        }
      },
      "additionalProperties": false
    },
    "UpgradeConfigurationResource": {
      "type": "object",
      "properties": {
        "AllowChecking": {
          "type": "boolean",
          "description": "Whether to check octopus.com to see if a new version is available."
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IncludeStatistics": {
          "type": "boolean",
          "description": "Deprecated: please use the [dedicated telemetry page](\" + OctoLink.BaseAddress + \"telemetry) to determine whether octopus sends usage statistics. See [our documentation](\" + OctoLink.BaseAddress + \"WhatIsIncludedInUsageStatistics) for information about what is included."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NotificationMode": {
          "type": "string",
          "description": "Controls which notifications are shown in the portal when an upgrade is available.",
          "enum": [
            "AlwaysShow",
            "ShowOnlyMajorMinor",
            "NeverShow"
          ]
        }
      },
      "additionalProperties": false
    },
    "UserPermissionRestriction": {
      "type": "object",
      "properties": {
        "RestrictedToEnvironmentIds": {
          "type": "array",
          "description": "Restrictions on the environments to which the permission applies, if any.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Environments-1",
            "..."
          ]
        },
        "RestrictedToProjectGroupIds": {
          "type": "array",
          "description": "Restrictions on the project groups to which the permission applies, if any.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "RestrictedToProjectIds": {
          "type": "array",
          "description": "Restrictions on the projects to which the permission applies, if any.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Projects-1",
            "..."
          ]
        },
        "RestrictedToTenantIds": {
          "type": "array",
          "description": "Restrictions on the tenants to which the permission applies, if any.",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "Tenants-1",
            "..."
          ]
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "UserPermissionSetResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsPermissionsComplete": {
          "type": "boolean",
          "description": "If the requesting user had sufficient access to see a complete view of the permissions"
        },
        "IsTeamsComplete": {
          "type": "boolean",
          "description": "If the requesting user had sufficient access to see a complete view of the teams that may drive permissions"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "SpacePermissions": {
          "type": "object",
          "description": "Lists individual permissions granted, including restrictions where applicable.",
          "properties": {
            "AdministerSystem": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProjectEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProjectView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProjectCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProjectDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProcessView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProcessEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "VariableEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "VariableEditUnscoped": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "VariableView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "VariableViewUnscoped": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ReleaseCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ReleaseView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ReleaseEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ReleaseDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "DefectReport": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "DefectResolve": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "DeploymentCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "DeploymentDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "DeploymentView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "EnvironmentView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "EnvironmentCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "EnvironmentEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "EnvironmentDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "MachineCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "MachineEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "MachineView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "MachineDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ArtifactView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ArtifactCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ArtifactEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ArtifactDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "FeedView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "EventView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "LibraryVariableSetView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "LibraryVariableSetCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "LibraryVariableSetEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "LibraryVariableSetDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProjectGroupView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProjectGroupCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProjectGroupEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProjectGroupDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TeamCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TeamView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TeamEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TeamDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "UserView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "UserInvite": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "UserRoleView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "UserRoleEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TaskView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TaskCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TaskCancel": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TaskEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TaskPrioritize": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "InterruptionView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "InterruptionSubmit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "InterruptionViewSubmitResponsible": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "BuiltInFeedPush": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "BuiltInFeedAdminister": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "BuiltInFeedDownload": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ActionTemplateView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ActionTemplateCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ActionTemplateEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ActionTemplateDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "LifecycleCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "LifecycleView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "LifecycleEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "LifecycleDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "AccountView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "AccountEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "AccountCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "AccountDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TenantCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TenantEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TenantView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TenantDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TagSetCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TagSetEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TagSetDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TelemetryView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "MachinePolicyCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "MachinePolicyView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "MachinePolicyEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "MachinePolicyDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProxyCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProxyView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProxyEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ProxyDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "SubscriptionCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "SubscriptionView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "SubscriptionEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "SubscriptionDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TriggerCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TriggerView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TriggerEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TriggerDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "CertificateView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "CertificateCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "CertificateEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "CertificateDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "CertificateExportPrivateKey": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "UserEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ConfigureServer": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "FeedEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "WorkerView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "WorkerEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "SpaceEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "SpaceView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "SpaceDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "SpaceCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "BuildInformationPush": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "BuildInformationAdminister": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "RunbookView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "RunbookEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "RunbookSnapshotCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "RunbookRunView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "RunbookRunDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "RunbookRunCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "GitCredentialView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "GitCredentialEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "EventRetentionDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "EventRetentionView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "InsightsReportView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "InsightsReportCreate": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "InsightsReportEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "InsightsReportDelete": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "DeploymentFreezeAdminister": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TargetTagView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "TargetTagAdminister": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "PlatformHubView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "PlatformHubEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "RetentionAdminister": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "FeatureToggleEdit": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "ApprovalPolicyAdminister": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "SshKnownHostsAdminister": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "SshKnownHostsView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "AiAgentTranscriptView": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            },
            "DeployedResourceAdminister": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/UserPermissionRestriction"
              }
            }
          },
          "additionalProperties": false
        },
        "SystemPermissions": {
          "type": "array",
          "description": "Lists individual system permissions granted, these do not have restrictions",
          "items": {
            "type": "string",
            "enum": [
              "AdministerSystem",
              "ProjectEdit",
              "ProjectView",
              "ProjectCreate",
              "ProjectDelete",
              "ProcessView",
              "ProcessEdit",
              "VariableEdit",
              "VariableEditUnscoped",
              "VariableView",
              "VariableViewUnscoped",
              "ReleaseCreate",
              "ReleaseView",
              "ReleaseEdit",
              "ReleaseDelete",
              "DefectReport",
              "DefectResolve",
              "DeploymentCreate",
              "DeploymentDelete",
              "DeploymentView",
              "EnvironmentView",
              "EnvironmentCreate",
              "EnvironmentEdit",
              "EnvironmentDelete",
              "MachineCreate",
              "MachineEdit",
              "MachineView",
              "MachineDelete",
              "ArtifactView",
              "ArtifactCreate",
              "ArtifactEdit",
              "ArtifactDelete",
              "FeedView",
              "EventView",
              "LibraryVariableSetView",
              "LibraryVariableSetCreate",
              "LibraryVariableSetEdit",
              "LibraryVariableSetDelete",
              "ProjectGroupView",
              "ProjectGroupCreate",
              "ProjectGroupEdit",
              "ProjectGroupDelete",
              "TeamCreate",
              "TeamView",
              "TeamEdit",
              "TeamDelete",
              "UserView",
              "UserInvite",
              "UserRoleView",
              "UserRoleEdit",
              "TaskView",
              "TaskCreate",
              "TaskCancel",
              "TaskEdit",
              "TaskPrioritize",
              "InterruptionView",
              "InterruptionSubmit",
              "InterruptionViewSubmitResponsible",
              "BuiltInFeedPush",
              "BuiltInFeedAdminister",
              "BuiltInFeedDownload",
              "ActionTemplateView",
              "ActionTemplateCreate",
              "ActionTemplateEdit",
              "ActionTemplateDelete",
              "LifecycleCreate",
              "LifecycleView",
              "LifecycleEdit",
              "LifecycleDelete",
              "AccountView",
              "AccountEdit",
              "AccountCreate",
              "AccountDelete",
              "TenantCreate",
              "TenantEdit",
              "TenantView",
              "TenantDelete",
              "TagSetCreate",
              "TagSetEdit",
              "TagSetDelete",
              "TelemetryView",
              "MachinePolicyCreate",
              "MachinePolicyView",
              "MachinePolicyEdit",
              "MachinePolicyDelete",
              "ProxyCreate",
              "ProxyView",
              "ProxyEdit",
              "ProxyDelete",
              "SubscriptionCreate",
              "SubscriptionView",
              "SubscriptionEdit",
              "SubscriptionDelete",
              "TriggerCreate",
              "TriggerView",
              "TriggerEdit",
              "TriggerDelete",
              "CertificateView",
              "CertificateCreate",
              "CertificateEdit",
              "CertificateDelete",
              "CertificateExportPrivateKey",
              "UserEdit",
              "ConfigureServer",
              "FeedEdit",
              "WorkerView",
              "WorkerEdit",
              "SpaceEdit",
              "SpaceView",
              "SpaceDelete",
              "SpaceCreate",
              "BuildInformationPush",
              "BuildInformationAdminister",
              "RunbookView",
              "RunbookEdit",
              "RunbookSnapshotCreate",
              "RunbookRunView",
              "RunbookRunDelete",
              "RunbookRunCreate",
              "GitCredentialView",
              "GitCredentialEdit",
              "EventRetentionDelete",
              "EventRetentionView",
              "InsightsReportView",
              "InsightsReportCreate",
              "InsightsReportEdit",
              "InsightsReportDelete",
              "DeploymentFreezeAdminister",
              "TargetTagView",
              "TargetTagAdminister",
              "PlatformHubView",
              "PlatformHubEdit",
              "RetentionAdminister",
              "FeatureToggleEdit",
              "ApprovalPolicyAdminister",
              "SshKnownHostsAdminister",
              "SshKnownHostsView",
              "AiAgentTranscriptView",
              "DeployedResourceAdminister"
            ]
          }
        },
        "Teams": {
          "type": "array",
          "description": "Gets the teams that the user is a member of.",
          "items": {
            "$ref": "#/definitions/ProjectedTeamReferenceDataItem"
          }
        }
      },
      "additionalProperties": false
    },
    "UserResource": {
      "type": "object",
      "required": [
        "DisplayName"
      ],
      "properties": {
        "CanPasswordBeEdited": {
          "type": "boolean"
        },
        "Created": {
          "type": "string",
          "format": "date-time"
        },
        "DisplayName": {
          "type": "string",
          "maxLength": 64,
          "minLength": 0
        },
        "EmailAddress": {
          "type": "string",
          "format": "email",
          "maxLength": 256,
          "minLength": 0
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Identities": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/IdentityResource"
          }
        },
        "IsActive": {
          "type": "boolean"
        },
        "IsRequestor": {
          "type": "boolean",
          "description": "Gets or sets a value indicating whether this user resource represents the user who requested it."
        },
        "IsService": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Password": {
          "type": "string"
        },
        "ServiceAccountType": {
          "type": "string",
          "enum": [
            "Standard",
            "Agent"
          ]
        },
        "Username": {
          "type": "string",
          "maxLength": 64,
          "minLength": 0
        }
      },
      "additionalProperties": false
    },
    "UserResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/UserResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "UserRoleResource": {
      "type": "object",
      "properties": {
        "CanBeDeleted": {
          "type": "boolean"
        },
        "Description": {
          "type": "string"
        },
        "GrantedSpacePermissions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "AdministerSystem",
              "ProjectEdit",
              "ProjectView",
              "ProjectCreate",
              "ProjectDelete",
              "ProcessView",
              "ProcessEdit",
              "VariableEdit",
              "VariableEditUnscoped",
              "VariableView",
              "VariableViewUnscoped",
              "ReleaseCreate",
              "ReleaseView",
              "ReleaseEdit",
              "ReleaseDelete",
              "DefectReport",
              "DefectResolve",
              "DeploymentCreate",
              "DeploymentDelete",
              "DeploymentView",
              "EnvironmentView",
              "EnvironmentCreate",
              "EnvironmentEdit",
              "EnvironmentDelete",
              "MachineCreate",
              "MachineEdit",
              "MachineView",
              "MachineDelete",
              "ArtifactView",
              "ArtifactCreate",
              "ArtifactEdit",
              "ArtifactDelete",
              "FeedView",
              "EventView",
              "LibraryVariableSetView",
              "LibraryVariableSetCreate",
              "LibraryVariableSetEdit",
              "LibraryVariableSetDelete",
              "ProjectGroupView",
              "ProjectGroupCreate",
              "ProjectGroupEdit",
              "ProjectGroupDelete",
              "TeamCreate",
              "TeamView",
              "TeamEdit",
              "TeamDelete",
              "UserView",
              "UserInvite",
              "UserRoleView",
              "UserRoleEdit",
              "TaskView",
              "TaskCreate",
              "TaskCancel",
              "TaskEdit",
              "TaskPrioritize",
              "InterruptionView",
              "InterruptionSubmit",
              "InterruptionViewSubmitResponsible",
              "BuiltInFeedPush",
              "BuiltInFeedAdminister",
              "BuiltInFeedDownload",
              "ActionTemplateView",
              "ActionTemplateCreate",
              "ActionTemplateEdit",
              "ActionTemplateDelete",
              "LifecycleCreate",
              "LifecycleView",
              "LifecycleEdit",
              "LifecycleDelete",
              "AccountView",
              "AccountEdit",
              "AccountCreate",
              "AccountDelete",
              "TenantCreate",
              "TenantEdit",
              "TenantView",
              "TenantDelete",
              "TagSetCreate",
              "TagSetEdit",
              "TagSetDelete",
              "TelemetryView",
              "MachinePolicyCreate",
              "MachinePolicyView",
              "MachinePolicyEdit",
              "MachinePolicyDelete",
              "ProxyCreate",
              "ProxyView",
              "ProxyEdit",
              "ProxyDelete",
              "SubscriptionCreate",
              "SubscriptionView",
              "SubscriptionEdit",
              "SubscriptionDelete",
              "TriggerCreate",
              "TriggerView",
              "TriggerEdit",
              "TriggerDelete",
              "CertificateView",
              "CertificateCreate",
              "CertificateEdit",
              "CertificateDelete",
              "CertificateExportPrivateKey",
              "UserEdit",
              "ConfigureServer",
              "FeedEdit",
              "WorkerView",
              "WorkerEdit",
              "SpaceEdit",
              "SpaceView",
              "SpaceDelete",
              "SpaceCreate",
              "BuildInformationPush",
              "BuildInformationAdminister",
              "RunbookView",
              "RunbookEdit",
              "RunbookSnapshotCreate",
              "RunbookRunView",
              "RunbookRunDelete",
              "RunbookRunCreate",
              "GitCredentialView",
              "GitCredentialEdit",
              "EventRetentionDelete",
              "EventRetentionView",
              "InsightsReportView",
              "InsightsReportCreate",
              "InsightsReportEdit",
              "InsightsReportDelete",
              "DeploymentFreezeAdminister",
              "TargetTagView",
              "TargetTagAdminister",
              "PlatformHubView",
              "PlatformHubEdit",
              "RetentionAdminister",
              "FeatureToggleEdit",
              "ApprovalPolicyAdminister",
              "SshKnownHostsAdminister",
              "SshKnownHostsView",
              "AiAgentTranscriptView",
              "DeployedResourceAdminister"
            ]
          }
        },
        "GrantedSystemPermissions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "AdministerSystem",
              "ProjectEdit",
              "ProjectView",
              "ProjectCreate",
              "ProjectDelete",
              "ProcessView",
              "ProcessEdit",
              "VariableEdit",
              "VariableEditUnscoped",
              "VariableView",
              "VariableViewUnscoped",
              "ReleaseCreate",
              "ReleaseView",
              "ReleaseEdit",
              "ReleaseDelete",
              "DefectReport",
              "DefectResolve",
              "DeploymentCreate",
              "DeploymentDelete",
              "DeploymentView",
              "EnvironmentView",
              "EnvironmentCreate",
              "EnvironmentEdit",
              "EnvironmentDelete",
              "MachineCreate",
              "MachineEdit",
              "MachineView",
              "MachineDelete",
              "ArtifactView",
              "ArtifactCreate",
              "ArtifactEdit",
              "ArtifactDelete",
              "FeedView",
              "EventView",
              "LibraryVariableSetView",
              "LibraryVariableSetCreate",
              "LibraryVariableSetEdit",
              "LibraryVariableSetDelete",
              "ProjectGroupView",
              "ProjectGroupCreate",
              "ProjectGroupEdit",
              "ProjectGroupDelete",
              "TeamCreate",
              "TeamView",
              "TeamEdit",
              "TeamDelete",
              "UserView",
              "UserInvite",
              "UserRoleView",
              "UserRoleEdit",
              "TaskView",
              "TaskCreate",
              "TaskCancel",
              "TaskEdit",
              "TaskPrioritize",
              "InterruptionView",
              "InterruptionSubmit",
              "InterruptionViewSubmitResponsible",
              "BuiltInFeedPush",
              "BuiltInFeedAdminister",
              "BuiltInFeedDownload",
              "ActionTemplateView",
              "ActionTemplateCreate",
              "ActionTemplateEdit",
              "ActionTemplateDelete",
              "LifecycleCreate",
              "LifecycleView",
              "LifecycleEdit",
              "LifecycleDelete",
              "AccountView",
              "AccountEdit",
              "AccountCreate",
              "AccountDelete",
              "TenantCreate",
              "TenantEdit",
              "TenantView",
              "TenantDelete",
              "TagSetCreate",
              "TagSetEdit",
              "TagSetDelete",
              "TelemetryView",
              "MachinePolicyCreate",
              "MachinePolicyView",
              "MachinePolicyEdit",
              "MachinePolicyDelete",
              "ProxyCreate",
              "ProxyView",
              "ProxyEdit",
              "ProxyDelete",
              "SubscriptionCreate",
              "SubscriptionView",
              "SubscriptionEdit",
              "SubscriptionDelete",
              "TriggerCreate",
              "TriggerView",
              "TriggerEdit",
              "TriggerDelete",
              "CertificateView",
              "CertificateCreate",
              "CertificateEdit",
              "CertificateDelete",
              "CertificateExportPrivateKey",
              "UserEdit",
              "ConfigureServer",
              "FeedEdit",
              "WorkerView",
              "WorkerEdit",
              "SpaceEdit",
              "SpaceView",
              "SpaceDelete",
              "SpaceCreate",
              "BuildInformationPush",
              "BuildInformationAdminister",
              "RunbookView",
              "RunbookEdit",
              "RunbookSnapshotCreate",
              "RunbookRunView",
              "RunbookRunDelete",
              "RunbookRunCreate",
              "GitCredentialView",
              "GitCredentialEdit",
              "EventRetentionDelete",
              "EventRetentionView",
              "InsightsReportView",
              "InsightsReportCreate",
              "InsightsReportEdit",
              "InsightsReportDelete",
              "DeploymentFreezeAdminister",
              "TargetTagView",
              "TargetTagAdminister",
              "PlatformHubView",
              "PlatformHubEdit",
              "RetentionAdminister",
              "FeatureToggleEdit",
              "ApprovalPolicyAdminister",
              "SshKnownHostsAdminister",
              "SshKnownHostsView",
              "AiAgentTranscriptView",
              "DeployedResourceAdminister"
            ]
          }
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string"
        },
        "SpacePermissionDescriptions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SupportedRestrictions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "SystemPermissionDescriptions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "UserRoleResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/UserRoleResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "ValidateBuiltInPackageResponse": {
      "type": "object",
      "properties": {
        "Issue": {
          "type": "string",
          "enum": [
            "CorruptedNugetPackage",
            "CouldNotValidate",
            "EmptyFile",
            "FileNameTooLong",
            "InvalidCharactersInFileName",
            "InvalidPackageId",
            "PackageAlreadyExists",
            "UnsupportedFileExtension"
          ]
        }
      },
      "additionalProperties": false
    },
    "ValidateDeploymentProcessInDatabaseResponse": {
      "type": "object",
      "required": [
        "Details",
        "HasWarnings",
        "TagsWithoutTargetsByStepId"
      ],
      "properties": {
        "Details": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "HasWarnings": {
          "type": "boolean"
        },
        "TagsWithoutTargetsByStepId": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "additionalProperties": false
    },
    "ValidateDeploymentProcessInGitResponse": {
      "type": "object",
      "required": [
        "Details",
        "HasWarnings",
        "TagsWithoutTargetsByStepId"
      ],
      "properties": {
        "Details": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "HasWarnings": {
          "type": "boolean"
        },
        "TagsWithoutTargetsByStepId": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "additionalProperties": false
    },
    "ValidatedGitReferenceResource": {
      "type": "object",
      "required": [
        "CanonicalName",
        "Name"
      ],
      "properties": {
        "CanonicalName": {
          "type": "string",
          "minLength": 1
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "ValidateGitRefCommand": {
      "type": "object",
      "required": [
        "GitRef",
        "ProjectId",
        "SpaceId"
      ],
      "properties": {
        "GitRef": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string",
          "description": "ID of the Project",
          "example": "Projects-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        }
      },
      "additionalProperties": false
    },
    "ValidateGitRefResponse": {
      "type": "object",
      "properties": {
        "Error": {
          "type": "string"
        },
        "ValidatedGitRef": {
          "$ref": "#/definitions/ValidatedGitReferenceResource"
        }
      },
      "additionalProperties": false
    },
    "VariablePromptOptions": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "DisplaySettings": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Label": {
          "type": "string"
        },
        "Required": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "VariableResource": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "IsEditable": {
          "type": "boolean"
        },
        "IsSensitive": {
          "type": "boolean"
        },
        "Name": {
          "type": "string"
        },
        "Prompt": {
          "$ref": "#/definitions/VariablePromptOptions"
        },
        "Scope": {
          "type": "object",
          "properties": {
            "Project": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Environment": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Machine": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Role": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "TargetRole": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Action": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "User": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Trigger": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "ParentDeployment": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Private": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Channel": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "TenantTag": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "Tenant": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "ProcessOwner": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "ProjectTemplate": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "TemplatedProject": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "ProcessTemplateStep": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "EnvironmentParameter": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "TargetTagParameter": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            },
            "TenantTagParameter": {
              "type": "array",
              "description": "The current implementation holds the strings in an insertion-sorted List, rather than a HashSet. This means that when enumerated, it will return values in a predictable order, but you should not make assumptions about this from outside the class. This tradeoff is deliberate, it improves enumeration and equality-comparison performance, but we lose the ability to do fast Contains() lookups. ScopeValue does not expose any Contains() method, so we can be fairly confident the tradeoff is good.",
              "items": {
                "type": "string"
              }
            }
          },
          "additionalProperties": false
        },
        "Type": {
          "type": "string"
        },
        "Value": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "VariableScopeValues": {
      "type": "object",
      "properties": {
        "Actions": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        },
        "Channels": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        },
        "EnvironmentParameters": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        },
        "Environments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        },
        "Machines": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        },
        "Processes": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ProcessReferenceDataItem"
          }
        },
        "ProcessTemplateSteps": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        },
        "Roles": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        },
        "TargetTagParameters": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        },
        "TenantTagParameters": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        },
        "TenantTags": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ReferenceDataItem"
          }
        }
      },
      "additionalProperties": false
    },
    "VariableSetResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "OwnerId": {
          "type": "string",
          "description": "Gets or sets the ID of the document that owns these variables."
        },
        "ScopeValues": {
          "$ref": "#/definitions/VariableScopeValues"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "Variables": {
          "type": "array",
          "description": "Gets the collection of variables.",
          "items": {
            "$ref": "#/definitions/VariableResource"
          }
        },
        "Version": {
          "type": "integer",
          "description": "Gets or sets the version number.",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "VariablesScopedToDocumentResource": {
      "type": "object",
      "required": [
        "HasUnauthorizedLibraryVariableSetVariables",
        "HasUnauthorizedProjectVariables",
        "VariableMap"
      ],
      "properties": {
        "HasUnauthorizedLibraryVariableSetVariables": {
          "type": "boolean"
        },
        "HasUnauthorizedProjectVariables": {
          "type": "boolean"
        },
        "VariableMap": {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "additionalProperties": {
              "type": "integer",
              "format": "int32"
            }
          }
        }
      },
      "additionalProperties": false
    },
    "VerifySigningKeysCommandV1": {
      "type": "object",
      "properties": {
        "IncludeExpiredKeys": {
          "type": "boolean"
        },
        "Issuer": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "VerifySigningKeysResponseV1": {
      "type": "object",
      "additionalProperties": false
    },
    "VersioningStrategyResource": {
      "type": "object",
      "properties": {
        "DonorPackage": {
          "$ref": "#/definitions/DeploymentActionPackageResource"
        },
        "Template": {
          "type": "string"
        }
      },
      "additionalProperties": { }
    },
    "WorkerPoolDynamicWorkerTypesResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "WorkerTypes": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/DynamicWorkerType"
          }
        }
      },
      "additionalProperties": false
    },
    "WorkerPoolResource": {
      "type": "object",
      "properties": {
        "CanAddWorkers": {
          "type": "boolean"
        },
        "Description": {
          "type": "string",
          "description": "Gets or sets a short description of this pool that can be used to explain the purpose of the pool to other users. May describe the kinds of machines in the pool. This field may contain markdown."
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDefault": {
          "type": "boolean",
          "description": "Is this the default pool. The default pool is used for steps that don't specify a worker pool. The default pool, if empty, uses the builtin worker to run steps."
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "Name": {
          "type": "string",
          "description": "Gets or sets the name of this pool. This should be short, preferably 5-20 characters."
        },
        "Slug": {
          "type": "string"
        },
        "SortOrder": {
          "type": "integer",
          "description": "Gets or sets a number indicating the priority of this pool in sort order. Pools with a lower sort order will appear in the UI before items with a higher sort order.",
          "format": "int32"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "WorkerPoolType": {
          "type": "string",
          "enum": [
            "StaticWorkerPool",
            "DynamicWorkerPool"
          ]
        }
      },
      "additionalProperties": false
    },
    "WorkerPoolResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkerPoolResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "WorkerPoolsSummaryResource": {
      "type": "object",
      "properties": {
        "MachineEndpointSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineHealthStatusSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineIdsForCalamariUpgrade": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "MachineIdsForTentacleUpgrade": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "TentacleUpgradesRequired": {
          "type": "boolean"
        },
        "TotalDisabledMachines": {
          "type": "integer",
          "format": "int32"
        },
        "TotalMachines": {
          "type": "integer",
          "format": "int32"
        },
        "WorkerPoolSummaries": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkerPoolSummaryResource"
          }
        }
      },
      "additionalProperties": false
    },
    "WorkerPoolSummaryResource": {
      "type": "object",
      "properties": {
        "MachineEndpointSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineHealthStatusSummaries": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        },
        "MachineIdsForCalamariUpgrade": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "MachineIdsForTentacleUpgrade": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "TentacleUpgradesRequired": {
          "type": "boolean"
        },
        "TotalDisabledMachines": {
          "type": "integer",
          "format": "int32"
        },
        "TotalMachines": {
          "type": "integer",
          "format": "int32"
        },
        "WorkerPool": {
          "$ref": "#/definitions/WorkerPoolResource"
        }
      },
      "additionalProperties": false
    },
    "WorkerPoolSupportedTypesResource": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "SupportedPoolTypes": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "StaticWorkerPool",
              "DynamicWorkerPool"
            ]
          }
        }
      },
      "additionalProperties": false
    },
    "WorkerResource": {
      "type": "object",
      "properties": {
        "Architecture": {
          "type": "string"
        },
        "Endpoint": {
          "$ref": "#/definitions/EndpointResource"
        },
        "HasLatestCalamari": {
          "type": "boolean"
        },
        "HealthStatus": {
          "type": "string",
          "enum": [
            "Healthy",
            "Unavailable",
            "Unknown",
            "HasWarnings",
            "Unhealthy"
          ]
        },
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "IsDisabled": {
          "type": "boolean"
        },
        "IsInProcess": {
          "type": "boolean"
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "MachinePolicyId": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "OperatingSystem": {
          "type": "string"
        },
        "OperatingSystemVersion": {
          "type": "string"
        },
        "ShellName": {
          "type": "string"
        },
        "ShellVersion": {
          "type": "string"
        },
        "SkipInitialHealthCheck": {
          "type": "boolean"
        },
        "Slug": {
          "type": "string"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "StatusSummary": {
          "type": "string"
        },
        "Thumbprint": {
          "type": "string"
        },
        "Uri": {
          "type": "string"
        },
        "WorkerPoolIds": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "example": [
            "WorkerPools-1",
            "..."
          ]
        }
      },
      "additionalProperties": false
    },
    "WorkerResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkerResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "WorkerResourcePaginatedCollection": {
      "type": "object",
      "properties": {
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkerResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "WorkerTaskLeaseResource": {
      "type": "object",
      "properties": {
        "Exclusive": {
          "type": "boolean"
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "ServerTaskId": {
          "type": "string",
          "example": "ServerTasks-1"
        },
        "SpaceId": {
          "type": "string",
          "example": "Spaces-1"
        },
        "TakenAt": {
          "type": "string",
          "format": "date-time"
        },
        "WorkerId": {
          "type": "string",
          "example": "Workers-1"
        },
        "WorkerPoolId": {
          "type": "string",
          "example": "WorkerPools-1"
        }
      },
      "additionalProperties": false
    },
    "WorkerTaskLeaseResourceCollection": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Gets or sets a unique identifier for this resource."
        },
        "Items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkerTaskLeaseResource"
          }
        },
        "ItemsPerPage": {
          "type": "integer",
          "format": "int32"
        },
        "ItemType": {
          "type": "string",
          "readOnly": true
        },
        "LastModifiedBy": {
          "type": "string",
          "description": "Gets or sets the username of the user who last modified this resource."
        },
        "LastModifiedOn": {
          "type": "string",
          "description": "Gets or sets the date/time that this resource was last modified.",
          "format": "date-time"
        },
        "LastPageNumber": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "Links": {
          "type": "object",
          "description": "Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "NumberOfPages": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "TotalResults": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "WorkItemLink": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        },
        "LinkUrl": {
          "type": "string"
        },
        "Source": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "X509Certificate": {
      "type": "object",
      "properties": {
        "IssuerDistinguishedName": {
          "type": "string"
        },
        "NotAfter": {
          "type": "string",
          "format": "date-time"
        },
        "NotBefore": {
          "type": "string",
          "format": "date-time"
        },
        "SerialNumber": {
          "type": "string"
        },
        "SignatureAlgorithmName": {
          "type": "string"
        },
        "SubjectDistinguishedName": {
          "type": "string"
        },
        "Thumbprint": {
          "type": "string"
        },
        "Version": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    }
  },
  "securityDefinitions": {
    "APIKeyHeader": {
      "type": "apiKey",
      "name": "X-Octopus-ApiKey",
      "in": "header"
    },
    "APIKeyQuery": {
      "type": "apiKey",
      "name": "ApiKey",
      "in": "query"
    },
    "NugetApiKeyHeader": {
      "type": "apiKey",
      "name": "X-NuGet-ApiKey",
      "in": "header"
    }
  },
  "security": [
    {
      "APIKeyHeader": [ ]
    },
    {
      "APIKeyQuery": [ ]
    },
    {
      "NugetApiKeyHeader": [ ]
    }
  ],
  "tags": [
    {
      "name": "AccessTokens"
    },
    {
      "name": "Accounts"
    },
    {
      "name": "ActionTemplates"
    },
    {
      "name": "ApiKeys"
    },
    {
      "name": "ApprovalRules"
    },
    {
      "name": "Approvals"
    },
    {
      "name": "Artifacts"
    },
    {
      "name": "AuditStream"
    },
    {
      "name": "Authentication"
    },
    {
      "name": "Branches"
    },
    {
      "name": "BuildInformation"
    },
    {
      "name": "Capabilities"
    },
    {
      "name": "Certificates"
    },
    {
      "name": "Channels"
    },
    {
      "name": "CloudTemplate"
    },
    {
      "name": "CommunityActionTemplates"
    },
    {
      "name": "CompliancePolicies"
    },
    {
      "name": "Configuration"
    },
    {
      "name": "ConnectionAgents"
    },
    {
      "name": "Dashboard"
    },
    {
      "name": "DashboardConfiguration"
    },
    {
      "name": "DeploymentFreeze"
    },
    {
      "name": "DeploymentProcesses"
    },
    {
      "name": "Deployments"
    },
    {
      "name": "DeploymentSettings"
    },
    {
      "name": "DeploymentTargets"
    },
    {
      "name": "DeploymentTargetTags"
    },
    {
      "name": "Deprecations"
    },
    {
      "name": "DynamicExtensions"
    },
    {
      "name": "Environments"
    },
    {
      "name": "EphemeralEnvironments"
    },
    {
      "name": "EventRetention"
    },
    {
      "name": "Events"
    },
    {
      "name": "ExternalSecurityGroupProviders"
    },
    {
      "name": "FeaturesConfiguration"
    },
    {
      "name": "FeatureToggles"
    },
    {
      "name": "Feeds"
    },
    {
      "name": "GitHub"
    },
    {
      "name": "Home"
    },
    {
      "name": "Icons"
    },
    {
      "name": "Insights"
    },
    {
      "name": "IntegratedAuthentication"
    },
    {
      "name": "Interruptions"
    },
    {
      "name": "Invitations"
    },
    {
      "name": "JsonWebKeys"
    },
    {
      "name": "LegacyExtensibility"
    },
    {
      "name": "LetsEncrypt"
    },
    {
      "name": "LibraryVariableSets"
    },
    {
      "name": "Licenses"
    },
    {
      "name": "Lifecycles"
    },
    {
      "name": "MachinePolicies"
    },
    {
      "name": "MachineRoles"
    },
    {
      "name": "Machines"
    },
    {
      "name": "MaintenanceConfiguration"
    },
    {
      "name": "Migrations"
    },
    {
      "name": "Nuget"
    },
    {
      "name": "Observability"
    },
    {
      "name": "OctopusServerNodes"
    },
    {
      "name": "OpenIdConnect"
    },
    {
      "name": "OpenTelemetry"
    },
    {
      "name": "Packages"
    },
    {
      "name": "ParentEnvironments"
    },
    {
      "name": "Performance"
    },
    {
      "name": "Permissions"
    },
    {
      "name": "PlatformHub"
    },
    {
      "name": "ProcessTemplates"
    },
    {
      "name": "Progression"
    },
    {
      "name": "ProjectGroups"
    },
    {
      "name": "Projects"
    },
    {
      "name": "Runbooks"
    },
    {
      "name": "ProjectTemplates"
    },
    {
      "name": "ProjectTriggers"
    },
    {
      "name": "Proxies"
    },
    {
      "name": "RateLimiting"
    },
    {
      "name": "Releases"
    },
    {
      "name": "Reporting"
    },
    {
      "name": "Retention"
    },
    {
      "name": "RolloutGroups"
    },
    {
      "name": "RunbookProcesses"
    },
    {
      "name": "RunbookRuns"
    },
    {
      "name": "RunbookSnapshots"
    },
    {
      "name": "ScheduledJobs"
    },
    {
      "name": "ScopedUserRoles"
    },
    {
      "name": "Server"
    },
    {
      "name": "ServerStatus"
    },
    {
      "name": "ServerTaskApprovals"
    },
    {
      "name": "ServiceAccountOidcIdentities"
    },
    {
      "name": "Signing"
    },
    {
      "name": "Smtp"
    },
    {
      "name": "Spaces"
    },
    {
      "name": "SshKnownHosts"
    },
    {
      "name": "Subscriptions"
    },
    {
      "name": "TagSets"
    },
    {
      "name": "Tasks"
    },
    {
      "name": "TeamMemberships"
    },
    {
      "name": "Teams"
    },
    {
      "name": "Telemetry"
    },
    {
      "name": "Tenants"
    },
    {
      "name": "TokenExchange"
    },
    {
      "name": "Upgrade"
    },
    {
      "name": "UserPermissions"
    },
    {
      "name": "UserRoles"
    },
    {
      "name": "Users"
    },
    {
      "name": "Variables"
    },
    {
      "name": "VersionControl"
    },
    {
      "name": "Web"
    },
    {
      "name": "WorkerPools"
    },
    {
      "name": "Workers"
    },
    {
      "name": "WorkerTaskLeases"
    }
  ],
  "externalDocs": {
    "description": "Further API Documentation",
    "url": "https://oc.to/ApiDocs"
  }
}