Primeiros passos com a Azion API

Autentique-se na Azion API com um personal token, liste os seus workloads e crie, leia, renomeie e exclua uma network list.

Última atualização

Ver como Markdown Configurar agente

Este guia orienta você nas suas primeiras requisições à Azion API.

  • Obtenha um personal token para autenticar as suas requisições.
  • Liste os workloads da sua conta.
  • Crie uma network list.
  • Leia a network list e renomeie-a.
  • Exclua a network list e confirme que ela não existe mais.

Toda requisição vai para a URL base https://api.azion.com/v4 e leva o seu personal token no header Authorization. O guia cria um único objeto, uma network list com um endereço IP, e não o vincula a mais nada. Você o exclui na última etapa, e a conta termina como começou.

A Azion CLI chega aos mesmos resultados pelo terminal. Cada etapa mostra a requisição à API e o comando da CLI que corresponde a ela. Para todos os endpoints, com exemplos de requisição em curl e em outras linguagens, consulte a referência da Azion API.

Escolha API ou CLI uma vez. Os pré-requisitos e as cinco etapas mudam para essa interface.

Pré-requisitos

  • curl ou outro cliente HTTP.

Obtenha um personal token

Um personal token autentica as suas requisições à Azion API e à Azion CLI. Para criar um no Azion Console, consulte Gerencie personal tokens. Copie o token quando o Azion Console o exibir, porque você só consegue vê-lo no momento em que o cria.

A Azion API lê o token do header Authorization. Toda requisição deste guia o envia nesta forma:

Authorization: Token [TOKEN VALUE]

A API também aceita um personal token com o esquema Bearer: Authorization: Bearer [TOKEN VALUE]. Você tem o header que autentica todas as requisições das próximas etapas.

Salve o token na Azion CLI. Substitua [TOKEN VALUE] pelo seu token:

azion -t [TOKEN VALUE]

A CLI guarda o token na pasta de configuração dela, e os comandos seguintes o usam sem a flag. Para mais informações sobre a configuração da CLI, consulte Primeiros passos com a Azion CLI.

Liste os seus workloads

Uma requisição de listagem retorna os workloads da sua conta e confirma que o token funciona. A resposta é uma página de resultados.

Envie uma requisição GET ao endpoint de workloads. O parâmetro page_size=100 pede até 100 workloads em uma página, e fields=id retorna apenas o ID de cada workload:

Shell
01curl --request GET \
02 --url 'https://api.azion.com/v4/workspace/workloads?page_size=100&fields=id' \
03 --header 'Accept: application/json' \
04 --header 'Authorization: Token [TOKEN VALUE]'

Um 200 retorna a página de workloads:

JSON
01{
02 "count": 17,
03 "total_pages": 1,
04 "page": 1,
05 "page_size": 100,
06 "next": null,
07 "previous": null,
08 "results": [
09 {"id": 1234567890},
10 {"id": 1234567891},
11 {"id": 1234567892},
12 {"id": 1234567893},
13 {"id": 1234567894},
14 {"id": 1234567895},
15 {"id": 1234567896},
16 {"id": 1234567897},
17 {"id": 1234567898},
18 {"id": 1234567899},
19 {"id": 1234567900},
20 {"id": 1234567901},
21 {"id": 1234567902},
22 {"id": 1234567903},
23 {"id": 1234567904},
24 {"id": 1234567905},
25 {"id": 1234567906}
26 ]
27}

O campo count contém o número de workloads da conta, e results contém os workloads da página. Uma resposta de listagem traz count, total_pages, page, page_size, next, previous e results. Para paginação, fields, ordering e search, consulte Azion API.

Liste os workloads com a Azion CLI. A flag --page-size 1 retorna um workload, e --details adiciona colunas:

azion list workload --page-size 1 --details

O comando imprime uma linha para o workload:

Texto
01ID NAME ACTIVE LAST EDITOR LAST MODIFIED
021234567890 my-blog true you@example.com 2026-01-01 12:00:00.000000 +0000 UTC

Sem --page-size, azion list workload imprime o ID e o nome de todos os workloads da conta.

Crie uma network list

Uma network list contém um conjunto de valores de um único tipo. A requisição precisa de um name, de um type e dos items da lista. O type aceita ip_cidr, asn ou countries, e items aceita de 1 a 20.000 entradas. Este guia cria uma lista ip_cidr com um endereço do intervalo de documentação 192.0.2.0/24.

Envie uma requisição POST ao endpoint de network lists:

Shell
01curl --request POST \
02 --url https://api.azion.com/v4/workspace/network_lists \
03 --header 'Accept: application/json' \
04 --header 'Authorization: Token [TOKEN VALUE]' \
05 --header 'Content-Type: application/json' \
06 --data '{"name": "my-ip-list", "type": "ip_cidr", "items": ["192.0.2.10"]}'

Um 201 retorna a network list dentro de data, com "state": "executed":

JSON
01{
02 "state": "executed",
03 "data": {
04 "id": 1234567890,
05 "name": "my-ip-list",
06 "type": "ip_cidr",
07 "items": ["192.0.2.10"],
08 "last_editor": "you@example.com",
09 "last_modified": "2026-01-01T12:00:00.000000Z",
10 "created_at": "2026-01-01T12:00:00.000000Z",
11 "active": true,
12 "version_id": null,
13 "version_state": null,
14 "is_versioned": false,
15 "version": null
16 }
17}

O campo active assume true como padrão quando a requisição o omite. Anote o id. As próximas etapas o enviam na URL.

Crie a network list com a Azion CLI:

azion create network-list --name my-ip-list --type ip_cidr --items 192.0.2.10

O comando imprime o ID da network list:

Created Network List with ID 12345

Anote o ID. As próximas etapas o passam para --network-list-id.

Leia e renomeie a network list

A leitura da network list retorna os valores atuais dela. Uma renomeação altera um campo e mantém os outros como estão.

Envie uma requisição GET à network list. Substitua <network-list-id> pelo id que a requisição de criação retornou:

Shell
01curl --request GET \
02 --url https://api.azion.com/v4/workspace/network_lists/<network-list-id> \
03 --header 'Accept: application/json' \
04 --header 'Authorization: Token [TOKEN VALUE]'

Um 200 retorna a network list dentro de data:

JSON
01{
02 "data": {
03 "id": 1234567890,
04 "name": "my-ip-list",
05 "type": "ip_cidr",
06 "items": ["192.0.2.10"],
07 "last_editor": "you@example.com",
08 "last_modified": "2026-01-01T12:00:00.000000Z",
09 "created_at": "2026-01-01T12:00:00.000000Z",
10 "active": true,
11 "version_id": null,
12 "version_state": null,
13 "is_versioned": false,
14 "version": null
15 }
16}

Para renomear a network list, envie uma requisição PATCH apenas com o novo name:

Shell
01curl --request PATCH \
02 --url https://api.azion.com/v4/workspace/network_lists/<network-list-id> \
03 --header 'Accept: application/json' \
04 --header 'Authorization: Token [TOKEN VALUE]' \
05 --header 'Content-Type: application/json' \
06 --data '{"name": "my-ip-list-renamed"}'

Um 200 retorna a network list com o novo nome e um novo last_modified:

JSON
01{
02 "state": "executed",
03 "data": {
04 "id": 1234567890,
05 "name": "my-ip-list-renamed",
06 "type": "ip_cidr",
07 "items": ["192.0.2.10"],
08 "last_editor": "you@example.com",
09 "last_modified": "2026-01-01T12:01:00.000000Z",
10 "created_at": "2026-01-01T12:00:00.000000Z",
11 "active": true,
12 "version_id": null,
13 "version_state": null,
14 "is_versioned": false,
15 "version": null
16 }
17}

Os campos type e items mantêm os valores da requisição de criação.

Descreva a network list. Substitua <network-list-id> pelo ID que o comando de criação imprimiu:

azion describe network-list --network-list-id <network-list-id>

O comando imprime o nome, o tipo, os itens e o estado da network list:

Texto
01ID: 12345
02Name: my-ip-list
03Type: ip_cidr
04Items: ["192.0.2.10"]
05Last Editor: you@example.com
06Last Modified: "2026-01-01T12:00:00.000000Z"
07Active: true

Renomeie a network list:

azion update network-list --network-list-id <network-list-id> --name my-ip-list-renamed

O comando confirma a atualização:

Updated Network List with ID 12345

Descreva a network list novamente:

azion describe network-list --network-list-id <network-list-id>

A saída mostra o novo nome e um novo valor em Last Modified, e o tipo e os itens não mudam:

Texto
01ID: 12345
02Name: my-ip-list-renamed
03Type: ip_cidr
04Items: ["192.0.2.10"]
05Last Editor: you@example.com
06Last Modified: "2026-01-01T12:01:00.000000Z"
07Active: true

Exclua a network list

A exclusão da network list devolve a conta ao estado que ela tinha antes de você criar a lista.

Envie uma requisição DELETE à network list:

Shell
01curl --request DELETE \
02 --url https://api.azion.com/v4/workspace/network_lists/<network-list-id> \
03 --header 'Accept: application/json' \
04 --header 'Authorization: Token [TOKEN VALUE]'

Um 200 retorna apenas o estado da operação:

{"state": "executed"}

Para confirmar a exclusão, envie novamente a requisição GET que leu a lista. Um 404 retorna o envelope de erro:

{"errors": [{"code": "10004", "title": "Not Found", "detail": "Not found.", "status": "404"}]}

A network list não existe mais.

Exclua a network list com a Azion CLI:

azion delete network-list --network-list-id <network-list-id>

O comando confirma a exclusão:

Network List 12345 was successfully deleted

Para confirmar a exclusão, descreva a network list novamente:

azion describe network-list --network-list-id <network-list-id>

O comando sai com o status 1 e imprime o erro:

Error: Failed to describe Network List: The given ID or API's endpoint doesn't exist or isn't available. Check that the identifying information is correct

A network list não existe mais.

Próximos passos

Azion APIA URL base, a autenticação, a paginação, os parâmetros de query e os limites de requisição da API.Solucionar problemas da Azion APICausas e correções dos erros que a API retorna, por código de status.Network listsOs campos, os tipos de lista e os erros de uma network list, e como uma regra de firewall a compara.Azion CLI network-listTodas as flags dos comandos que criam, listam, descrevem, atualizam e excluem network lists.