Alterar um destino

PATCH

/v1/ingest/destinations/{id}

Campo ausente fica como está. status é enabled ou disabled, e reativar um destino desligado por falhas zera a contagem dele. headers substitui os headers fixos inteiros.

Autorização

• Bearer

Parâmetros

Parâmetros de caminho

id

obrigatório

string

Corpo da requisição^obrigatório

Tipo de mídiaapplication/json

object

url

obrigatório

null | string

description

obrigatório

null | string

status

obrigatório

null | string

headers

obrigatório

null | object

Exemplo^gerado

{
  "url": "example",
  "description": "example",
  "status": "example",
  "headers": "example"
}

Respostas

200

Sucesso.

Tipo de mídiaapplication/json

object

id

obrigatório

string

url

obrigatório

string

description

obrigatório

null | string

status

obrigatório

string

customHeaders

obrigatório

object

key

propriedades adicionais

string

createdAt

obrigatório

string formato: date-time

Exemplo^gerado

{
  "id": "example",
  "url": "example",
  "description": "example",
  "status": "example",
  "customHeaders": {
    "additionalProperty": "example"
  },
  "createdAt": "2026-04-15T12:00:00Z"
}

401

Chave de API ausente, inválida ou revogada.

404

O destino não existe, ou não é deste ambiente.

422

URL recusada pela validação, status inválido, ou header inválido.

Tipo de mídiaapplication/problem+json

object

type

null | string

title

null | string

status

null | integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Exemplo^gerado

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Limite de requisições por segundo do plano, somado entre todas as chaves da organização.

Headers

Retry-After

integer

Segundos até a próxima janela.