GET /api/http_proxies
Liste de proxies HTTP

Exemples

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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

search
optionel

filtrer les résultats

Validations:

  • Must be a String

order
optionel

Champ et sens de tri, ex: ‘id DESC’

Validations:

  • Must be a String

page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.

per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.


GET /api/http_proxies/:id
Afficher un proxy HTTP

Exemples

GET /api/http_proxies/4
200
{
  "id": 4,
  "name": "http_proxies",
  "url": "http://url_18",
  "username": null
}

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

ID numérique ou nom du proxy HTTP

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
Créer un proxy HTTP

Exemples

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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

http_proxy
requis

Validations:

  • Must be a Hash

http_proxy[name]
requis

Nom du proxy HTTP

Validations:

  • Must be a String

http_proxy[url]
requis

URL du proxy HTTP

Validations:

  • Must be a String

http_proxy[username]
optionel , nil autorisé

Nom d’utilisateur permettant de s’authentifier auprès du proxy HTTP

Validations:

  • Must be a String

http_proxy[password]
optionel , nil autorisé

Mot de passe utilisé pour s’authentifier auprès du proxy HTTP

Validations:

  • Must be a String

http_proxy[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type


PUT /api/http_proxies/:id
Mettre à jour un proxy HTTP

Exemples

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
}

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

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
requis

Validations:

  • Must be a Hash

http_proxy[name]
optionel

Nom du proxy HTTP

Validations:

  • Must be a String

http_proxy[url]
optionel

URL du proxy HTTP

Validations:

  • Must be a String

http_proxy[username]
optionel , nil autorisé

Nom d’utilisateur permettant de s’authentifier auprès du proxy HTTP

Validations:

  • Must be a String

http_proxy[password]
optionel , nil autorisé

Mot de passe utilisé pour s’authentifier auprès du proxy HTTP

Validations:

  • Must be a String

http_proxy[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type


DELETE /api/http_proxies/:id
Supprimer un proxy HTTP

Exemples

DELETE /api/http_proxies/3
{
  "http_proxy": {}
}
200
{
  "id": 3,
  "name": "http_proxies",
  "url": "http://url_17",
  "username": null,
  "password": null
}

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

Validations:

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