Install an Ansible collection

Cloud Mock

https://mock.apidog.com/m1/1126461-0-default

POST

/ansible/collection

Install an ansible collection by name or URL.
Admins can pass a userID parameter to install a collection for other users.
Ansible collections can only be removed by rm-ing their directories. This is not supported via Ludus due to potential edge cases in naming depending on how the collection was installed.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

Query Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

collection installed

Bodyapplication/json

🟠409Conflict

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://mock.apidog.com/m1/1126461-0-default/ansible/collection?userID=undefined' \
--header 'X-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "collection": "maxhoesel.smallstep",
    "version": "0.23.1",
    "force": true
}'

Response Example

201 - Example 1

{
    "result": "Successfully installed: maxhoesel.smallstep"
}

Modified at 2026-05-05 19:09:52

Install an Ansible role from local directory

whoami