Requires the images-sources-view
capability.
Returns a list of Image Sources.
General error response from the platform
{- "data": [
- {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "type": "stack-build",
- "hub_id": "651586fca6078e98982dbd90",
- "name": "string",
- "about": {
- "description": "string"
}, - "origin": {
- "type": "docker-hub",
- "details": {
- "existing": {
- "source_id": "651586fca6078e98982dbd90"
}, - "target": "string",
- "username": "string",
- "token": "string"
}
}, - "builder": {
- "integration_id": "my-image-source"
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}, - "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "meta": {
- "images_count": {
- "total": 0,
- "state": {
- "new": 0,
- "downloading": 0,
- "building": 0,
- "verifying": 0,
- "saving": 0,
- "live": 0,
- "deleting": 0
}
}
}
}
], - "includes": {
- "creators": {
- "accounts": {
- "property1": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}, - "property2": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}
}, - "employees": null,
- "visitors": null,
- "environments": null,
- "api_keys": null
}, - "integrations": {
- "property1": {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "vendor": "string",
- "identifier": "string",
- "auth": {
- "region": "string",
- "namespace": "string",
- "api_key": "string",
- "key_id": "string",
- "secret": "string",
- "subscription_id": "string",
- "client_id": "string",
- "base64_config": "string"
}, - "extra": {
- "property1": "string",
- "property2": "string"
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "meta": {
- "definition": {
- "vendor": "string",
- "name": "string",
- "supports_verification": true,
- "supports_multiple": true,
- "features": [
- "string"
], - "extends": [
- "string"
], - "extended_configuration": {
- "options": [
- { }
]
}, - "fields": {
- "extra": {
- "property1": { },
- "property2": { }
}, - "auth": {
- "property1": { },
- "property2": { }
}
}, - "public": true,
- "usable": true,
- "editable": true
}
}
}, - "property2": {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "vendor": "string",
- "identifier": "string",
- "auth": {
- "region": "string",
- "namespace": "string",
- "api_key": "string",
- "key_id": "string",
- "secret": "string",
- "subscription_id": "string",
- "client_id": "string",
- "base64_config": "string"
}, - "extra": {
- "property1": "string",
- "property2": "string"
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "meta": {
- "definition": {
- "vendor": "string",
- "name": "string",
- "supports_verification": true,
- "supports_multiple": true,
- "features": [
- "string"
], - "extends": [
- "string"
], - "extended_configuration": {
- "options": [
- { }
]
}, - "fields": {
- "extra": {
- "property1": { },
- "property2": { }
}, - "auth": {
- "property1": { },
- "property2": { }
}
}, - "public": true,
- "usable": true,
- "editable": true
}
}
}
}, - "integrations:identifiers": {
- "property1": [
- "651586fca6078e98982dbd90"
], - "property2": [
- "651586fca6078e98982dbd90"
]
}
}
}
Requires the images-sources-manage
capability.
Parameters for creating an Image Source.
Returns an Image Source.
General error response from the platform
{- "name": "string",
- "identifier": "string",
- "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}, - "builder": {
- "integration_id": "my-image-source"
}, - "type": "stack-build",
- "origin": {
- "type": "docker-hub",
- "details": {
- "existing": {
- "source_id": "651586fca6078e98982dbd90"
}, - "target": "string",
- "username": "string",
- "token": "string"
}
}, - "about": {
- "description": "string"
}
}
{- "data": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "type": "stack-build",
- "hub_id": "651586fca6078e98982dbd90",
- "name": "string",
- "about": {
- "description": "string"
}, - "origin": {
- "type": "docker-hub",
- "details": {
- "existing": {
- "source_id": "651586fca6078e98982dbd90"
}, - "target": "string",
- "username": "string",
- "token": "string"
}
}, - "builder": {
- "integration_id": "my-image-source"
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}, - "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "meta": {
- "images_count": {
- "total": 0,
- "state": {
- "new": 0,
- "downloading": 0,
- "building": 0,
- "verifying": 0,
- "saving": 0,
- "live": 0,
- "deleting": 0
}
}
}
}
}
Requires the images-sources-view
capability.
Returns an Image Source.
General error response from the platform
{- "data": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "type": "stack-build",
- "hub_id": "651586fca6078e98982dbd90",
- "name": "string",
- "about": {
- "description": "string"
}, - "origin": {
- "type": "docker-hub",
- "details": {
- "existing": {
- "source_id": "651586fca6078e98982dbd90"
}, - "target": "string",
- "username": "string",
- "token": "string"
}
}, - "builder": {
- "integration_id": "my-image-source"
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}, - "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "meta": {
- "images_count": {
- "total": 0,
- "state": {
- "new": 0,
- "downloading": 0,
- "building": 0,
- "verifying": 0,
- "saving": 0,
- "live": 0,
- "deleting": 0
}
}
}
}, - "includes": {
- "creators": {
- "accounts": {
- "property1": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}, - "property2": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}
}, - "employees": null,
- "visitors": null,
- "environments": null,
- "api_keys": null
}, - "integrations": {
- "property1": {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "vendor": "string",
- "identifier": "string",
- "auth": {
- "region": "string",
- "namespace": "string",
- "api_key": "string",
- "key_id": "string",
- "secret": "string",
- "subscription_id": "string",
- "client_id": "string",
- "base64_config": "string"
}, - "extra": {
- "property1": "string",
- "property2": "string"
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "meta": {
- "definition": {
- "vendor": "string",
- "name": "string",
- "supports_verification": true,
- "supports_multiple": true,
- "features": [
- "string"
], - "extends": [
- "string"
], - "extended_configuration": {
- "options": [
- { }
]
}, - "fields": {
- "extra": {
- "property1": { },
- "property2": { }
}, - "auth": {
- "property1": { },
- "property2": { }
}
}, - "public": true,
- "usable": true,
- "editable": true
}
}
}, - "property2": {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "vendor": "string",
- "identifier": "string",
- "auth": {
- "region": "string",
- "namespace": "string",
- "api_key": "string",
- "key_id": "string",
- "secret": "string",
- "subscription_id": "string",
- "client_id": "string",
- "base64_config": "string"
}, - "extra": {
- "property1": "string",
- "property2": "string"
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "meta": {
- "definition": {
- "vendor": "string",
- "name": "string",
- "supports_verification": true,
- "supports_multiple": true,
- "features": [
- "string"
], - "extends": [
- "string"
], - "extended_configuration": {
- "options": [
- { }
]
}, - "fields": {
- "extra": {
- "property1": { },
- "property2": { }
}, - "auth": {
- "property1": { },
- "property2": { }
}
}, - "public": true,
- "usable": true,
- "editable": true
}
}
}
}, - "integrations:identifiers": {
- "property1": [
- "651586fca6078e98982dbd90"
], - "property2": [
- "651586fca6078e98982dbd90"
]
}
}
}
Requires the images-sources-manage
capability.
Parameters for updating an image source.
Returns an Image Source.
General error response from the platform
{- "name": "string",
- "identifier": "string",
- "origin": {
- "type": "docker-hub",
- "details": {
- "existing": {
- "source_id": "651586fca6078e98982dbd90"
}, - "target": "string",
- "username": "string",
- "token": "string"
}
}, - "builder": {
- "integration_id": "my-image-source"
}, - "about": {
- "description": "string"
}
}
{- "data": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "type": "stack-build",
- "hub_id": "651586fca6078e98982dbd90",
- "name": "string",
- "about": {
- "description": "string"
}, - "origin": {
- "type": "docker-hub",
- "details": {
- "existing": {
- "source_id": "651586fca6078e98982dbd90"
}, - "target": "string",
- "username": "string",
- "token": "string"
}
}, - "builder": {
- "integration_id": "my-image-source"
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}, - "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "meta": {
- "images_count": {
- "total": 0,
- "state": {
- "new": 0,
- "downloading": 0,
- "building": 0,
- "verifying": 0,
- "saving": 0,
- "live": 0,
- "deleting": 0
}
}
}
}
}
Requires the images-sources-manage
capability.
Returns a Job Descriptor.
General error response from the platform
{- "data": {
- "action": "string",
- "job": {
- "id": "string",
- "accepted": true,
- "queue": "string",
- "schedule": "2021-01-30T08:30:00Z",
- "parallel": {
- "sub_queue": "string",
- "tasks": true
}, - "tasks": [
- {
- "caption": "string",
- "header": "string",
- "steps": [
- {
- "caption": "string",
- "description": "string",
- "started": "2021-01-30T08:30:00Z",
- "completed": "2021-01-30T08:30:00Z"
}
], - "input": {
- "property1": null,
- "property2": null
}
}
]
}
}
}
Requires the images-sources-manage
capability. If an ACL is present, requires the manage
privilege.
Returns an Image Source.
General error response from the platform
{- "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}
}
{- "data": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "type": "stack-build",
- "hub_id": "651586fca6078e98982dbd90",
- "name": "string",
- "about": {
- "description": "string"
}, - "origin": {
- "type": "docker-hub",
- "details": {
- "existing": {
- "source_id": "651586fca6078e98982dbd90"
}, - "target": "string",
- "username": "string",
- "token": "string"
}
}, - "builder": {
- "integration_id": "my-image-source"
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}, - "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "meta": {
- "images_count": {
- "total": 0,
- "state": {
- "new": 0,
- "downloading": 0,
- "building": 0,
- "verifying": 0,
- "saving": 0,
- "live": 0,
- "deleting": 0
}
}
}
}
}