Install items from source

Developing

Cloud Mock

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

POST

/sources/{sourceID}/install

Installs a selection of blueprints/templates/ansible items to a registered source. Selection is persisted on the source record and honored by subsequent syncs.

Required ansible roles and collections, defined in a blueprint's manifest, are pulled automatically by installing a blueprint.

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: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200

application/json

Sync result.

Bodyapplication/json

🟠400

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://mock.apidog.com/m1/1126461-0-default/sources//install' \
--header 'X-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "selection": {
        "blueprints": [
            "string"
        ],
        "templates": [
            "string"
        ],
        "localRoles": [
            "string"
        ],
        "localCollections": [
            "string"
        ]
    },
    "global": true,
    "force": true,
    "noDeps": true
}'

Response Example

{
    "sourceID": "string",
    "templateResults": [
        {
            "name": "string",
            "ok": true,
            "message": "string"
        }
    ],
    "localAnsibleResults": {
        "roleResults": [
            {
                "name": "string",
                "ok": true,
                "message": "string"
            }
        ],
        "collectionResults": [
            {
                "name": "string",
                "ok": true,
                "message": "string"
            }
        ]
    },
    "blueprintResults": {
        "ansibleResults": [
            {
                "name": "string",
                "version": "string",
                "ok": true,
                "error": "string",
                "type": "role"
            }
        ],
        "undeclaredDependencies": [
            {
                "blueprintID": "string",
                "role": "string",
                "kind": "missing_role",
                "parentCollection": "string"
            }
        ]
    }
}

Modified at 2026-06-11 01:55:24

Get source catalog

Sync source