REST API

通过脚本启动表单和管理 AnsibleForms


面向开发人员和自动化工程师:通过脚本启动表单和管理 AnsibleForms。

Web 界面所做的一切都经过 REST API,因此脚本和其他工具也可以做同样的事。


概述

API 由 AnsibleForms 服务器在 /api/v2 下提供:

  • 完整参考:这些页面介绍脚本最常用的内容。所有端点都在服务器内置的 Swagger 页面 https://<your server>/api/v2/docs 上有说明,并可直接试用。
  • 权限:调用以其令牌所属用户的身份运行,使用该用户的角色,与浏览器中相同。
  • 运行验证:通过 API 启动的作业可以像浏览器中的启动一样接受检查 (参见 运行验证)。
  • 速率限制:只有登录、注销、令牌刷新和单点登录端点、修改密码 (PUT /api/v2/profile)以及 API 令牌端点(POST 和 DELETE /api/v2/profile/tokens)受到限制(参见 身份验证)。其他调用没有速率限制(聊天助手 有其自身的 限制),因此脚本应自行控制节奏,例如在跟踪作业时。

本节内容

每个主题都有单独的页面:

页面 内容
身份验证 登录、刷新令牌或使用长期令牌
作业 启动表单、跟踪作业、中止、重新运行或批准作业
响应和错误 响应的结构以及状态码
实时事件 在作业和设置发生变化时收到通知,而不必轮询