GET /api/http_proxies
HTTP-Proxies auflisten

Beispiele

GET /api/http_proxies
200
{
  "total": 0,
  "subtotal": 0,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": []
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Feld und Reihenfolge sortieren, z.B. ‘id DESC’

Validations:

  • Must be a String

page
optional

Seitennummer, beginnend bei 1

Validations:

  • Must be a number.

per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • Must be a number.


GET /api/http_proxies/:id
HTTP-Proxy anzeigen

Beispiele

GET /api/http_proxies/3
200
{
  "id": 3,
  "name": "http_proxy_225",
  "url": "http://url_225",
  "username": null
}

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
verpflichtend

Numerische Kennung oder HTTP-Proxy Name

Validations:

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


POST /api/http_proxies
HTTP-Proxy erstellen

Beispiele

POST /api/http_proxies
{
  "http_proxy": {
    "name": "http_proxy_is_smart",
    "url": "http://what????:5000"
  }
}
201
{
  "id": 1,
  "name": "http_proxy_is_smart",
  "url": "http://what????:5000",
  "username": null,
  "password": null
}

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

http_proxy
verpflichtend

Validations:

  • Must be a Hash

http_proxy[name]
verpflichtend

HTTP-Proxy Name

Validations:

  • Must be a String

http_proxy[url]
verpflichtend

URL des HTTP-Proxy

Validations:

  • Must be a String

http_proxy[username]
optional , nil erlaubt

Benutzername zur Authentifizierung am HTTP-Proxy

Validations:

  • Must be a String

http_proxy[password]
optional , nil erlaubt

Passwort zur Authentifizierung am HTTP-Proxy

Validations:

  • Must be a String

http_proxy[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


PUT /api/http_proxies/:id
HTTP-Proxy aktualisieren

Beispiele

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

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
verpflichtend

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
verpflichtend

Validations:

  • Must be a Hash

http_proxy[name]
optional

HTTP-Proxy Name

Validations:

  • Must be a String

http_proxy[url]
optional

URL des HTTP-Proxy

Validations:

  • Must be a String

http_proxy[username]
optional , nil erlaubt

Benutzername zur Authentifizierung am HTTP-Proxy

Validations:

  • Must be a String

http_proxy[password]
optional , nil erlaubt

Passwort zur Authentifizierung am HTTP-Proxy

Validations:

  • Must be a String

http_proxy[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


DELETE /api/http_proxies/:id
HTTP-Proxy löschen

Beispiele

DELETE /api/http_proxies/2
{
  "http_proxy": {}
}
200
{
  "id": 2,
  "name": "http_proxy_224",
  "url": "http://url_224",
  "username": null,
  "password": null
}

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

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