Create source

Developing

Cloud Mock

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

POST

/sources

Register a new source. For type=git supply url and (optionally) ref. For type=upload include an "archive" multipart file (tar.gz or zip).

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

Body Params multipart/form-data

Responses

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://mock.apidog.com/m1/1126461-0-default/sources' \
--header 'X-API-KEY: <api-key>' \
--form 'id=""' \
--form 'type=""' \
--form 'url=""' \
--form 'ref=""' \
--form 'global=""' \
--form 'force=""' \
--form 'archive=@""'

Response Example

{
    "sourceID": "string",
    "catalog": {
        "sourceID": "string",
        "sourceName": "string",
        "description": "string",
        "sourceType": "git",
        "lastSyncedAt": "string",
        "blueprints": {
            "items": [
                {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "version": "string",
                    "state": "not_installed",
                    "installedVersion": "string",
                    "requiredTemplates": [
                        "string"
                    ],
                    "requiredLocalRoles": [
                        "string"
                    ],
                    "requiredRoles": [
                        "string"
                    ],
                    "requiredCollections": [
                        "string"
                    ]
                }
            ],
            "requiredRoles": [
                {
                    "name": "string",
                    "description": "string",
                    "version": "string",
                    "state": "not_installed",
                    "installedVersion": "string",
                    "global": true,
                    "scopes": [
                        {
                            "scope": "string",
                            "version": "string",
                            "state": "installed"
                        }
                    ],
                    "type": "string",
                    "fqcn": "string",
                    "requiredBy": [
                        "string"
                    ],
                    "versionByBlueprint": {
                        "property1": "string",
                        "property2": "string"
                    }
                }
            ],
            "requiredCollections": [
                {
                    "name": "string",
                    "description": "string",
                    "version": "string",
                    "state": "not_installed",
                    "installedVersion": "string",
                    "global": true,
                    "scopes": [
                        {
                            "scope": "string",
                            "version": "string",
                            "state": "installed"
                        }
                    ],
                    "type": "string",
                    "fqcn": "string",
                    "requiredBy": [
                        "string"
                    ],
                    "versionByBlueprint": {
                        "property1": "string",
                        "property2": "string"
                    }
                }
            ],
            "subscriptionRoles": [
                {
                    "name": "string",
                    "description": "string",
                    "version": "string",
                    "state": "not_installed",
                    "installedVersion": "string",
                    "global": true,
                    "scopes": [
                        {
                            "scope": "string",
                            "version": "string",
                            "state": "installed"
                        }
                    ],
                    "type": "string",
                    "fqcn": "string",
                    "requiredBy": [
                        "string"
                    ],
                    "versionByBlueprint": {
                        "property1": "string",
                        "property2": "string"
                    }
                }
            ],
            "undeclaredDependencies": [
                {
                    "blueprintID": "string",
                    "role": "string",
                    "kind": "missing_role",
                    "parentCollection": "string"
                }
            ]
        },
        "templates": [
            {
                "name": "string",
                "description": "string",
                "version": "string",
                "state": "not_installed",
                "installedVersion": "string",
                "global": true,
                "scopes": [
                    {
                        "scope": "string",
                        "version": "string",
                        "state": "installed"
                    }
                ],
                "type": "string",
                "fqcn": "string",
                "requiredBy": [
                    "string"
                ],
                "versionByBlueprint": {
                    "property1": "string",
                    "property2": "string"
                }
            }
        ],
        "localRoles": [
            {
                "name": "string",
                "description": "string",
                "version": "string",
                "state": "not_installed",
                "installedVersion": "string",
                "global": true,
                "scopes": [
                    {
                        "scope": "string",
                        "version": "string",
                        "state": "installed"
                    }
                ],
                "type": "string",
                "fqcn": "string",
                "requiredBy": [
                    "string"
                ],
                "versionByBlueprint": {
                    "property1": "string",
                    "property2": "string"
                }
            }
        ],
        "localCollections": [
            {
                "name": "string",
                "description": "string",
                "version": "string",
                "state": "not_installed",
                "installedVersion": "string",
                "global": true,
                "scopes": [
                    {
                        "scope": "string",
                        "version": "string",
                        "state": "installed"
                    }
                ],
                "type": "string",
                "fqcn": "string",
                "requiredBy": [
                    "string"
                ],
                "versionByBlueprint": {
                    "property1": "string",
                    "property2": "string"
                }
            }
        ]
    }
}

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

Set default quotas for one or more groups (admin only)

Get source catalog