Examples

PUT /api/http_proxies/1
{
  "http_proxy": {
    "url": "https://some_other_url"
  }
}
200
{
  "id": 1,
  "url": "https://some_other_url",
  "name": "http_proxies",
  "username": null,
  "password": null
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organisations

Validations:

  • Must be a Integer

id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

http_proxy
required

Validations:

  • Must be a Hash

http_proxy[name]
optional

The HTTP Proxy name

Validations:

  • Must be a String

http_proxy[url]
optional

URL of the HTTP Proxy

Validations:

  • Must be a String

http_proxy[username]
optional , nil allowed

Username used to authenticate with the HTTP Proxy

Validations:

  • Must be a String

http_proxy[password]
optional , nil allowed

Password used to authenticate with the HTTP Proxy

Validations:

  • Must be a String

http_proxy[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
optional , nil allowed

REPLACE organisations with given ids.

Validations:

  • Must be an array of any type