Galaxy V3 API¶

以下部分描述了与 Galaxy NG API 相关的 API 端点。如果您有疑问或需要帮助，请在 Ansible 论坛上使用适当的标签发帖；例如，ansible-galaxy 或 galaxy-ng。

身份验证¶

要获取身份验证令牌，请访问 https://beta-galaxy.ansible.com/ui/token/ 并单击“加载令牌”按钮，然后复制提供的令牌。

警告

加载新令牌将使之前加载的任何令牌无效。

提示

当访问 /pulp/ 端点时，身份验证是通过传递 Basic 身份验证而不是令牌来执行的。

命名空间¶

列出命名空间¶

URL

https://beta-galaxy.ansible.com/api/v3/namespaces/

参数

limit: 返回的结果数量
offset: 结果中的偏移量
fields (可选): 要返回的字段的逗号分隔列表
exclude_fields (可选): 从响应中排除的字段的逗号分隔列表
company: 筛选以仅返回具有指定公司的命名空间
name: 筛选以仅返回具有指定名称的命名空间
keywords: 筛选以仅返回具有指定关键字的命名空间
sort: 用于对结果进行排序的字段的逗号分隔列表
可用值：-company, -id, -name, company, id, name

curl -X 'GET' \
  'https://beta-galaxy.ansible.com/api/v3/namespaces/?limit=2' \
  -H 'accept: application/json' \
  -H 'Authorization: Token YOURTOKEN'

{
  "meta":{
    "count":1421
  },
  "links":{
    "first":"/api/v3/namespaces/?limit=2&offset=0",
    "previous":null,
    "next":"/api/v3/namespaces/?limit=2&offset=2",
    "last":"/api/v3/namespaces/?limit=2&offset=1419"
  },
  "data":[
    {
      "pulp_href":"/api/pulp/api/v3/pulp_ansible/namespaces/1/",
      "id":1,
      "name":"adityamulik",
      "company":"",
      "email":"",
      "avatar_url":"",
      "description":"",
      "groups":[

      ],
      "related_fields":{

      },
      "metadata_sha256":"7c7df8772e0199517e72094ea38a44ccb09864f1d47b535e13efde9388fb90eb",
      "avatar_sha256":null
    },
    {
      "pulp_href":"/api/pulp/api/v3/pulp_ansible/namespaces/2/",
      "id":2,
      "name":"ansible",
      "company":"",
      "email":"",
      "avatar_url":"",
      "description":"",
      "groups":[

      ],
      "related_fields":{

      },
      "metadata_sha256":"68073fd148635456d3810a0367602ebfcd4a6f48736c93ffdcd48777cd1e0aeb",
      "avatar_sha256":null
    }
  ]
}

获取命名空间¶

URL

/api/v3/namespaces/{namespace_id}/

curl -X 'GET' \
  'https://beta-galaxy.ansible.com/api/v3/namespaces/ansible/' \        
  -H 'accept: application/json' \
  -H 'Authorization: Token YOURTOKEN'

{
  "pulp_href":"/api/pulp/api/v3/pulp_ansible/namespaces/2/",
  "id":2,
  "name":"ansible",
  "company":"",
  "email":"",
  "avatar_url":"",
  "description":"",
  "links":[

  ],
  "groups":[

  ],
  "resources":"",
  "related_fields":{

  },
  "metadata_sha256":"68073fd148635456d3810a0367602ebfcd4a6f48736c93ffdcd48777cd1e0aeb",
  "avatar_sha256":null
}

旧角色命名空间¶

URL

https://beta-galaxy.ansible.com/api/v1/roles/

curl -X 'GET' \
  'https://beta-galaxy.ansible.com/api/v1/roles/?page_size=2' \
  -H 'accept: application/json' \
  -H 'Authorization: Token YOURTOKEN'

{
  "count":31888,
  "next":"http://beta-galaxy.ansible.com/api/v1/roles/?page=2&page_size=2",
  "previous":null,
  "results":[
    {
      "id":1,
      "upstream_id":24559,
      "created":"2023-02-06T14:33:16.015752Z",
      "modified":"2023-02-06T14:33:16.018665Z",
      "github_user":"00willo",
      "username":"00willo",
      "github_repo":"ansible-role_sublimetext",
      "github_branch":null,
      "commit":"a1c5df38855094dbd9b09e1d2f576cb4644942d3",
      "name":"sublimetext-3",
      "description":"Install Sublime Text 3 on your machine. Supports both the dev and stable release channels.",
      "summary_fields":{
        "dependencies":[

        ],
        "namespace":{
          "id":1,
          "name":"00willo",
          "avatar_url":"https://github.com/00willo.png"
        },
        "provider_namespace":{
          "id":1,
          "name":"00willo"
        },
        "repository":{
          "name":"sublimetext-3",
          "original_name":"ansible-role_sublimetext"
        },
        "tags":[
          "development",
          "editor",
          "ide",
          "workstation"
        ],
        "versions":[

        ]
      }
    },
    {
      "id":2,
      "upstream_id":48126,
      "created":"2023-02-06T14:33:16.719592Z",
      "modified":"2023-02-06T14:33:16.722476Z",
      "github_user":"030",
      "username":"030",
      "github_repo":"ansible-bfg",
      "github_branch":null,
      "commit":"18a9d15033bb5131d0133187053b49a9f207f4f0",
      "name":"ansible_bfg",
      "description":"ansible-bfg",
      "summary_fields":{
        "dependencies":[

        ],
        "namespace":{
          "id":2,
          "name":"030",
          "avatar_url":"https://github.com/030.png"
        },
        "provider_namespace":{
          "id":2,
          "name":"030"
        },
        "repository":{
          "name":"ansible_bfg",
          "original_name":"ansible-bfg"
        },
        "tags":[
          "bfg"
        ],
        "versions":[
          {
            "id":124481,
            "url":"",
            "name":"1.0.0",
            "active":null,
            "created":"2020-04-22T08:10:56.446123Z",
            "related":{

            },
            "version":"1.0.0",
            "modified":"2020-04-22T08:10:56.446146Z",
            "commit_sha":"0c1894afb716e4ce716e09834f4a49a277300ff7",
            "commit_date":"2020-04-22T03:59:00-04:00",
            "download_url":"https://github.com/030/ansible-bfg/archive/1.0.0.tar.gz",
            "summary_fields":{

            }
          },
          {
            "id":125411,
            "url":"",
            "name":"1.0.1",
            "active":null,
            "created":"2020-05-03T07:55:52.421610Z",
            "related":{

            },
            "version":"1.0.1",
            "modified":"2020-05-03T07:55:52.421636Z",
            "commit_sha":"18a9d15033bb5131d0133187053b49a9f207f4f0",
            "commit_date":"2020-05-03T03:29:17-04:00",
            "download_url":"https://github.com/030/ansible-bfg/archive/1.0.1.tar.gz",
            "summary_fields":{

            }
          }
        ]
      }
    }
  ]
}

集合¶

列出集合¶

URL

/api/v3/plugin/ansible/content/published/collections/index/

参数

limit: 返回的结果数量
offset: 结果中的偏移量
namespace: 筛选以仅返回指定命名空间中的集合
name: 筛选以仅返回具有指定名称的集合
deprecated: 筛选以仅返回已弃用的集合
ordering: 用于对结果进行排序的字段的逗号分隔列表
可用值：-name, -namespace, -pk, -pulp_created, -pulp_id, -pulp_last_updated, name, namespace, pk, pulp_created, pulp_id, pulp_last_updated

curl -X 'GET' \
  'https://beta-galaxy.ansible.com/api/v3/plugin/ansible/content/published/collections/index/?limit=2' \
  -H 'accept: application/json' \
  -H 'Authorization: Token YOURTOKEN'

{
  "meta":{
    "count":2346
  },
  "links":{
    "first":"/api/v3/plugin/ansible/content/published/collections/index/?limit=2&offset=0",
    "previous":null,
    "next":"/api/v3/plugin/ansible/content/published/collections/index/?limit=2&offset=2",
    "last":"/api/v3/plugin/ansible/content/published/collections/index/?limit=2&offset=2344"
  },
  "data":[
    {
      "href":"/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/",
      "namespace":"namespace",
      "name":"collection_name",
      "deprecated":false,
      "versions_url":"/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/versions/",
      "highest_version":{
        "href":"/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/versions/1.0.4/",
        "version":"1.0.4"
      },
      "created_at":"2023-04-13T17:57:18.960283Z",
      "updated_at":"2023-04-13T18:10:23.981051Z"
    },
    {
      "href":"/api/v3/plugin/ansible/content/published/collections/index/namespace/nicecollection/",
      "namespace":"namespace",
      "name":"nicecollection",
      "deprecated":false,
      "versions_url":"/api/v3/plugin/ansible/content/published/collections/index/namespace/nicecollection/versions/",
      "highest_version":{
        "href":"/api/v3/plugin/ansible/content/published/collections/index/namespace/nicecollection/versions/1.0.1/",
        "version":"1.0.1"
      },
      "created_at":"2023-04-13T17:51:57.476396Z",
      "updated_at":"2023-04-13T18:10:23.981051Z"
    }
  ]
}

获取特定集合¶

URL

/api/v3/plugin/ansible/content/published/collections/index/{namespace}/{name}/

参数

fields (可选): 要返回的字段的逗号分隔列表
exclude_fields (可选): 从响应中排除的字段的逗号分隔列表

curl -X 'GET' \
  'https://beta-galaxy.ansible.com/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/' \
  -H 'accept: application/json' \                                   
  -H 'Authorization: Token YOURTOKEN'

{
  "href":"/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/",
  "namespace":"namespace",
  "name":"collection_name",
  "deprecated":false,
  "versions_url":"/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/versions/",
  "highest_version":{
    "href":"/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/versions/1.0.4/",
    "version":"1.0.4"
  },
  "created_at":"2023-04-13T17:57:18.960283Z",
  "updated_at":"2023-04-13T18:10:23.981051Z"
}

列出集合版本¶

URL

/api/v3/plugin/ansible/content/published/collections/index/{namespace}/{name}/versions/

参数

limit: 返回的结果数量
offset: 结果中的偏移量
is_highest: 筛选以仅返回集合的最高版本
ordering: 用于对结果进行排序的字段的逗号分隔列表
可用值：-authors, -contents, -dependencies, -description, -docs_blob, -documentation, -files, -homepage, -is_highest, -issues, -license, -manifest, -name, -namespace, -pk, -pulp_created, -pulp_id, -pulp_last_updated, -pulp_type, -repository, -requires_ansible, -search_vector, -timestamp_of_interest, -upstream_id, -version, authors, contents, dependencies, description, docs_blob, documentation, files, homepage, is_highest, issues, license, manifest, name, namespace, pk, pulp_created, pulp_id, pulp_last_updated, pulp_type, repository, requires_ansible, search_vector, timestamp_of_interest, upstream_id, version
tags: 用于筛选结果的标签的逗号分隔列表
fields (可选): 要返回的字段的逗号分隔列表
exclude_fields (可选): 从响应中排除的字段的逗号分隔列表

curl -X 'GET' \
  'https://beta-galaxy.ansible.com/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/versions/?limit=2' \
  -H 'accept: application/json' \
  -H 'Authorization: Token YOURTOKEN'

{
  "meta":{
    "count":5
  },
  "links":{
    "first":"/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/versions/?limit=2&offset=0",
    "previous":null,
    "next":"/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/versions/?limit=2&offset=2",
    "last":"/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/versions/?limit=2&offset=3"
  },
  "data":[
    {
      "version":"1.0.4",
      "href":"/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/versions/1.0.4/",
      "created_at":"2023-04-13T17:57:18.960283Z",
      "updated_at":"2023-04-13T17:57:18.960309Z",
      "requires_ansible":">=2.9.10",
      "marks":[

      ]
    },
    {
      "version":"1.0.3",
      "href":"/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/versions/1.0.3/",
      "created_at":"2023-04-13T17:57:18.960283Z",
      "updated_at":"2023-04-13T17:57:18.960309Z",
      "requires_ansible":">=2.9.10",
      "marks":[

      ]
    }
  ]
}

获取特定集合版本¶

URL

/api/v3/plugin/ansible/content/published/collections/index/{namespace}/{name}/versions/{version}/

参数

fields (可选): 要返回的字段的逗号分隔列表
exclude_fields (可选): 从响应中排除的字段的逗号分隔列表

curl -X 'GET' \
  'https://beta-galaxy.ansible.com/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/versions/1.0.3/' \  
  -H 'accept: application/json' \
  -H 'Authorization: Token YOURTOKEN'

{
  "version":"1.0.3",
  "href":"/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/versions/1.0.3/",
  "created_at":"2023-04-13T17:57:18.960283Z",
  "updated_at":"2023-04-13T17:57:18.960309Z",
  "requires_ansible":">=2.9.10",
  "marks":[

  ],
  "artifact":{
    "filename":"namespace-collection_name-1.0.3.tar.gz",
    "sha256":"3016ee8c1b75c7ee31fc58df757d8f349e73c0cb6af76f7279b1ffa211ede6f7",
    "size":8499
  },
  "collection":{
    "id":"80361571-1c6e-48b6-ab28-8c72ea3079cd",
    "name":"collection_name",
    "href":"/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/"
  },
  "download_url":"https://beta-galaxy.ansible.com/api/v3/plugin/ansible/content/published/collections/artifacts/namespace-collection_name-1.0.3.tar.gz",
  "name":"collection_name",
  "namespace":{
    "name":"namespace",
    "metadata_sha256":null
  },
  "signatures":[

  ],
  "metadata":{
    "authors":[
      "Efsdfsd Dfgsdgdfg <sdfsdfsd@sdfsdf.com>"
    ],
    "contents":[
      {
        "name":"csv_report",
        "description":"check several objects",
        "content_type":"role"
      }
    ],
    "dependencies":{

    },
    "description":"some handy roles put in a collections",
    "documentation":"https://github.com/namespace/collection_name-collections/blob/main/README.md",
    "homepage":"http://example.com",
    "issues":"http://example.com/issue/tracker",
    "license":[
      "GPL-2.0-or-later"
    ],
    "repository":"https://github.com/namespace/collection_name-collections",
    "tags":[
      "tools"
    ]
  },
  "git_url":null,
  "git_commit_sha":null,
  "manifest":{
    "format":1,
    "collection_info":{
      "name":"collection_name",
      "issues":"http://example.com/issue/tracker",
      "authors":[
        "Dfsfsd Dfsfds <sdfsdf@sfsdfsdf.com>"
      ],
      "license":[
        "GPL-2.0-or-later"
      ],
      "version":"1.0.3",
      "homepage":"http://example.com",
      "namespace":"namespace",
      "repository":"https://github.com/namespace/collection_name-collections",
      "description":"some handy roles put in a collections",
      "dependencies":{

      },
      "documentation":"https://github.com/namespace/collection_name-collections/blob/main/README.md"
    },
    "file_manifest_file":{
      "name":"FILES.json",
      "ftype":"file",
      "format":1,
      "chksum_type":"sha256",
      "chksum_sha256":"6ca424a6dec38d47d29d4c3c9ce6ddfdd5264be5bee1687b75eeb7d12bc5bd59"
    }
  },
  "files":{
    "files":[
      {
        "name":".",
        "ftype":"dir",
        "format":1,
        "chksum_type":null,
        "chksum_sha256":null
      },
      ...
      {
        "name":"README.md",
        "ftype":"file",
        "format":1,
        "chksum_type":"sha256",
        "chksum_sha256":"a3dbdbdc6d87aa0e9c8adae5481a91588cfc7a4f8f447b871ae39993a07927f0"
      }
    ],
    "format":1
  }
}

获取特定集合版本的文档¶

URL

/api/v3/plugin/ansible/content/published/collections/index/{namespace}/{name}/versions/{version}/docs-blob/

参数

fields (可选): 要返回的字段的逗号分隔列表
exclude_fields (可选): 从响应中排除的字段的逗号分隔列表

 curl -X 'GET' \
  'https://beta-galaxy.ansible.com/api/v3/plugin/ansible/content/published/collections/index/namespace/collection_name/versions/1.0.3/docs-blob/' \
  -H 'accept: application/json' \
  -H 'Authorization: Token YOURTOKEN'

{
  "docs_blob":{
    "contents":[
      {
        "doc_strings":{

        },
        "readme_file":"README.md",
        "readme_html":"<h1>Role Name: LONG README TEXT....</p>",
        "content_name":"csv_report",
        "content_type":"role"
      }
    ],
    "collection_readme":{
      "html":"<h1>Ansible Collection - namespace.collection_name</h1>\n<p>Documentation for the collection.</p>",
      "name":"README.md"
    },
    "documentation_files":[

    ]
  }
}

删除集合或特定版本¶

警告

此端点需要删除集合或版本的权限，您的用户必须列为命名空间所有者。

URL

/api/v3/plugin/ansible/content/published/collections/index/{namespace}/{name}/ /api/v3/plugin/ansible/content/published/collections/index/{namespace}/{name}/versions/{version}/

curl -X 'DELETE' \
'https://beta-galaxy.ansible.com/api/v3/plugin/ansible/content/published/collections/index/mynamespace/mycollection/' \
  -H 'accept: application/json' \
  -H 'Authorization: Token YOURTOKEN'

注意

删除集合也将删除该集合的所有版本，只有在没有其他已发布的集合依赖于正在删除的集合时，该任务才会成功。

上传集合¶

curl -X 'POST' \
  'http://beta-galaxy.ansible.com/api/v3/artifacts/collections/' \
  -H 'accept: application/json' \
  -H 'Content-Type: multipart/form-data' \
  -H 'Authorization: Token YOURTOKEN' \
  -F 'file=@namespace-name-1.0.0.tar.gz;type=application/gzip' \
  -F 'sha256=...'