Definir os headers de um endpoint

PUT

/v1/endpoints/{id}/headers

Headers fixos que vão em toda entrega para este endpoint, como uma credencial que o destino exige, por exemplo. A lista substitui a anterior inteira, e {} remove todos.

São até 20 headers, com nome de até 128 caracteres e valor de até 1.024. Os headers que o Notyfacil controla não podem ser definidos: notyfacil-id, notyfacil-timestamp, notyfacil-signature, Content-Type, Content-Length, Host, Connection, Transfer-Encoding e User-Agent.

Na LEITURA do endpoint, o valor volta mascarado para quem tem papel somente leitura no painel: o header fixo costuma carregar credencial, e quem não escreve não precisa dela. O nome continua visível. Pela chave de API o valor volta inteiro.

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

headers

obrigatório

null | object

Exemplo

{
  "headers": {
    "X-Api-Key": "chave-que-o-destino-exige"
  }
}

Respostas

200

Os headers fixos que ficaram valendo.

Tipo de mídiaapplication/json

object

key

propriedades adicionais

string

Exemplo^gerado

{
  "additionalProperty": "example"
}

401

Chave de API ausente, inválida ou revogada.

404

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

422

Header reservado, nome inválido, ou acima dos limites.

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.