GET /api/http_proxies
Lista de proxis HTTP

Ejemplos

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Orden y campo de clasificación, p. ej., ‘id DESC’

Validations:

  • Must be a String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.


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

Ejemplos

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

ID numérica o nombre de 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
Crear un proxy HTTP

Ejemplos

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
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

http_proxy
requerido

Validations:

  • Must be a Hash

http_proxy[name]
requerido

El nombre del proxy HTTP

Validations:

  • Must be a String

http_proxy[url]
requerido

URL del proxy HTTP

Validations:

  • Must be a String

http_proxy[username]
opcional , nil permitido

Nombre de usuario utilizado para autenticar con el proxy HTTP

Validations:

  • Must be a String

http_proxy[password]
opcional , nil permitido

Contraseña utilizada para autenticar con el proxy HTTP

Validations:

  • Must be a String

http_proxy[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


PUT /api/http_proxies/:id
Actualizar un proxy HTTP

Ejemplos

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
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

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
requerido

Validations:

  • Must be a Hash

http_proxy[name]
opcional

El nombre del proxy HTTP

Validations:

  • Must be a String

http_proxy[url]
opcional

URL del proxy HTTP

Validations:

  • Must be a String

http_proxy[username]
opcional , nil permitido

Nombre de usuario utilizado para autenticar con el proxy HTTP

Validations:

  • Must be a String

http_proxy[password]
opcional , nil permitido

Contraseña utilizada para autenticar con el proxy HTTP

Validations:

  • Must be a String

http_proxy[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


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

Ejemplos

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Validations:

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