GET /api/http_proxies
Lista de proxies HTTP

Exemplos

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

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Classificar campo e ordem, ex.: ‘id DESC’

Validations:

  • Must be a String

page
opcional

Número de página, iniciando em 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para retornar

Validations:

  • Must be a number.


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

Exemplos

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

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

id
requerido

ID numérica ou nome do 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
Criar um proxy HTTP

Exemplos

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
}

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

http_proxy
requerido

Validations:

  • Must be a Hash

http_proxy[name]
requerido

O nome do proxy HTTP

Validations:

  • Must be a String

http_proxy[url]
requerido

URL do proxy HTTP

Validations:

  • Must be a String

http_proxy[username]
opcional , nulo permitido

Nome de usuário usado para autenticar com o proxy HTTP

Validations:

  • Must be a String

http_proxy[password]
opcional , nulo permitido

A senha usada para autenticar com o proxy HTTP

Validations:

  • Must be a String

http_proxy[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


PUT /api/http_proxies/:id
Atualizar um proxy HTTP

Exemplos

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
}

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

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

O nome do proxy HTTP

Validations:

  • Must be a String

http_proxy[url]
opcional

URL do proxy HTTP

Validations:

  • Must be a String

http_proxy[username]
opcional , nulo permitido

Nome de usuário usado para autenticar com o proxy HTTP

Validations:

  • Must be a String

http_proxy[password]
opcional , nulo permitido

A senha usada para autenticar com o proxy HTTP

Validations:

  • Must be a String

http_proxy[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


DELETE /api/http_proxies/:id
Excluir um proxy HTTP

Exemplos

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

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

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.