Proxies

Create a Proxy in the specified Space

post/spaces/{spaceIdentifier}/proxies

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/proxies
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdentifierstring required

Identifier (ID or slug) of the space

Request body

Hoststring required
Namestring required
Portinteger required
ProxyTypestring

The type of proxy. Currently only HTTP is supported.

SpaceIdstring required

The ID of the space containing the resource.

Usernamestring

Example request

{
  "SpaceId": "Spaces-1"
}

Response

Created

Hoststring
Idstring

Gets or sets a unique identifier for this resource.

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

Namestring
Portinteger
ProxyTypestring
SpaceIdstring
Usernamestring

Example response

{
  "Links": {
    "Self": "/api/..."
  },
  "SpaceId": "Spaces-1"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.