Logotipo do enviardor de senha
Compartilhamento seguro Group & Co Nossos dados compartilhados com segurança

Password Pusher API v2

Documentação completa da API JSON para criar, recuperar e gerenciar notificações push na versão de código aberto.

Autenticação

Autenticar solicitações com um token Bearer no cabeçalho de Autorização.

Crie um token de API nas configurações da sua conta em /users/token. 

Authorization: Bearer YOUR_API_TOKEN
  • Pontos de extremidade públicos: GET /api/v2/version, GET /api/v2/pushes/:url_token, GET /api/v2/pushes/:url_token/preview
  • Pontos de extremidade autenticados: GET /api/v2/pushes/:url_token/audit, GET /api/v2/pushes/active, GET /api/v2/pushes/expired
  • Configuração de acesso anônimo: Quando as notificações anônimas estão desativadas, os endpoints da API exigem autenticação.

URL de base

Todos os endpoints são relativos ao seu host de instalação:

https://rundeck.groupsoftware.com.br/api/v2

Ponto final da versão

GET /api/v2/version

Returns API version, application details, and a features hash describing which capabilities are enabled on this instance.

Exemplo de cURL:

curl -X GET https://rundeck.groupsoftware.com.br/api/v2/version
{
  "application_version": "2.5.4",
  "api_version": "2.1",
  "edition": "oss",
  "features": {
    "anonymous_access": true,
    "api_token_authentication": true,
    "accounts": {
      "enabled": false
    },
    "pushes": {
      "enabled": true,
      "email_auto_dispatch": false,
      "file_attachments": {
        "enabled": true,
        "requires_authentication": true
      },
      "url_pushes": {
        "enabled": true
      },
      "qr_code_pushes": {
        "enabled": true
      }
    },
    "requests": {
      "enabled": false
    }
  }
}

Features Hash

  • anonymous_access - Whether anonymous API usage is allowed (Settings.allow_anonymous)
  • api_token_authentication - Bearer token authentication support
  • accounts.enabled - Accounts API availability (not available in OSS)
  • pushes.enabled - Push creation and management via API
  • pushes.file_attachments.enabled - File attachments on pushes (Settings.enable_file_pushes)
  • pushes.url_pushes.enabled - URL push type (Settings.enable_url_pushes)
  • pushes.qr_code_pushes.enabled - QR code push type (Settings.enable_qr_pushes)
  • requests.enabled - Requests API availability (not available in OSS)

Endpoints de envio

POST /api/v2/pushes

Criar uma nova notificação push.

Formato do corpo: { "push": { ... } }

Parâmetro Tipo Obrigatório Descrição
payloadstringSimTexto secreto para notificações push via SMS, URL ou QR Code.
filesarrayNãoArquivos a serem anexados. Quando presentes, o tipo de envio será "arquivo", a menos que o tipo seja explicitamente fornecido.
kindstringNãoTipo de envio: texto, arquivo, URL ou QR Code. O padrão é texto quando nenhum tipo é fornecido.
expire_after_daysintegerNãoPeríodo de expiração em dias. Se omitido, serão utilizados os valores padrão da instância.
expire_after_viewsintegerNãoNúmero máximo de recuperações permitidas. Se omitido, os valores padrão da instância serão usados.
deletable_by_viewerbooleanNãoPermite que o destinatário expire a notificação push.
retrieval_stepbooleanNãoAdiciona uma etapa extra de confirmação de recuperação.
passphrasestringNãoÉ necessária esta senha para recuperar o conteúdo.
namestringNãoEtiqueta opcional mostrada ao proprietário.
notestringNãoNota opcional apenas para o proprietário.
 
{
  "push": {
    "payload": "my-secret",
    "expire_after_days": 1,
    "expire_after_views": 5,
    "passphrase": "optional-passphrase",
    "deletable_by_viewer": true,
    "retrieval_step": true
  }
}

Exemplo de cURL (corpo JSON):

curl -X POST https://rundeck.groupsoftware.com.br/api/v2/pushes \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "push": {
      "payload": "my-secret",
      "expire_after_days": 1,
      "expire_after_views": 5
    }
  }'

GET /api/v2/pushes/:url_token

Recupere o conteúdo de uma notificação push por meio de um token. Isso conta como uma visualização e pode expirar a notificação quando os limites forem atingidos.

Parâmetros de consulta: passphrase (Opcional, obrigatório quando a notificação push estiver protegida por senha.)

Exemplo de cURL:

curl -X GET https://rundeck.groupsoftware.com.br/api/v2/pushes/YOUR_URL_TOKEN

GET /api/v2/pushes/:url_token/preview

Retorna a URL secreta completa de uma notificação push sem recuperar seu conteúdo.

Exemplo de cURL:

curl -X GET https://rundeck.groupsoftware.com.br/api/v2/pushes/YOUR_URL_TOKEN/preview

GET /api/v2/pushes/:url_token/audit

Retorna os registros de auditoria para uma notificação push. Autenticação e comprovação de propriedade são necessárias.

Parâmetros de consulta: page (Opcional, número inteiro, valor padrão 1, intervalo válido de 1 a 200.)

Exemplo de cURL:

curl -X GET "https://rundeck.groupsoftware.com.br/api/v2/pushes/YOUR_URL_TOKEN/audit?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

DELETE /api/v2/pushes/:url_token

Expira uma notificação push imediatamente. Permitido para proprietários (quando autenticados) ou para destinatários quando a notificação push foi criada com a opção `deletable_by_viewer` ativada.

Exemplo de cURL:

curl -X DELETE https://rundeck.groupsoftware.com.br/api/v2/pushes/YOUR_URL_TOKEN \
  -H "Authorization: Bearer YOUR_API_TOKEN"

GET /api/v2/pushes/active

Liste as notificações push ativas para o usuário autenticado.

Parâmetros de consulta: page (Opcional, número inteiro, valor padrão 1, intervalo válido de 1 a 200.)

Exemplo de cURL:

curl -X GET "https://rundeck.groupsoftware.com.br/api/v2/pushes/active?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

GET /api/v2/pushes/expired

Listar notificações push expiradas para o usuário autenticado.

Parâmetros de consulta: page (Opcional, número inteiro, valor padrão 1, intervalo válido de 1 a 200.)

Exemplo de cURL:

curl -X GET "https://rundeck.groupsoftware.com.br/api/v2/pushes/expired?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Códigos de status HTTP

  • 200 - Solicitação bem-sucedida
  • 201 - Empurrão criado
  • 400 - Parâmetros de solicitação inválidos
  • 401 - Autenticação necessária ou token inválido
  • 403 - Proibido para o usuário atual
  • 404 - Recurso não encontrado
  • 422 - Erro de validação

Para obter a documentação legada da API v1, consulte /api.