Chapter 35. Image Integration Service
35.1. Image Integration Service Copy linkLink copied to clipboard!
35.1.1. DeleteImageIntegration Copy linkLink copied to clipboard!
DELETE /v1/imageintegrations/{id}
DeleteImageIntegration removes a image integration given its ID.
35.1.1.1. Description Copy linkLink copied to clipboard!
35.1.1.2. Parameters Copy linkLink copied to clipboard!
35.1.1.2.1. Path Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
35.1.1.3. Return Type Copy linkLink copied to clipboard!
Object
35.1.1.4. Content Type Copy linkLink copied to clipboard!
- application/json
35.1.1.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
35.1.1.6. Samples Copy linkLink copied to clipboard!
35.1.2. GetImageIntegration Copy linkLink copied to clipboard!
GET /v1/imageintegrations/{id}
GetImageIntegration returns the image integration given its ID.
35.1.2.1. Description Copy linkLink copied to clipboard!
35.1.2.2. Parameters Copy linkLink copied to clipboard!
35.1.2.2.1. Path Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
35.1.2.3. Return Type Copy linkLink copied to clipboard!
35.1.2.4. Content Type Copy linkLink copied to clipboard!
- application/json
35.1.2.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
35.1.2.6. Samples Copy linkLink copied to clipboard!
35.1.3. GetImageIntegrations Copy linkLink copied to clipboard!
GET /v1/imageintegrations
GetImageIntegrations returns all image integrations that match the request filters.
35.1.3.1. Description Copy linkLink copied to clipboard!
35.1.3.2. Parameters Copy linkLink copied to clipboard!
35.1.3.2.1. Query Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| name | - | null | ||
| cluster | - | null |
35.1.3.3. Return Type Copy linkLink copied to clipboard!
35.1.3.4. Content Type Copy linkLink copied to clipboard!
- application/json
35.1.3.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
35.1.3.6. Samples Copy linkLink copied to clipboard!
35.1.4. PostImageIntegration Copy linkLink copied to clipboard!
POST /v1/imageintegrations
PostImageIntegration creates a image integration.
35.1.4.1. Description Copy linkLink copied to clipboard!
35.1.4.2. Parameters Copy linkLink copied to clipboard!
35.1.4.2.1. Body Parameter Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
35.1.4.3. Return Type Copy linkLink copied to clipboard!
35.1.4.4. Content Type Copy linkLink copied to clipboard!
- application/json
35.1.4.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
35.1.4.6. Samples Copy linkLink copied to clipboard!
35.1.5. PutImageIntegration Copy linkLink copied to clipboard!
PUT /v1/imageintegrations/{id}
PutImageIntegration modifies a given image integration, without using stored credential reconciliation.
35.1.5.1. Description Copy linkLink copied to clipboard!
35.1.5.2. Parameters Copy linkLink copied to clipboard!
35.1.5.2.1. Path Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
35.1.5.2.2. Body Parameter Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
35.1.5.3. Return Type Copy linkLink copied to clipboard!
Object
35.1.5.4. Content Type Copy linkLink copied to clipboard!
- application/json
35.1.5.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
35.1.5.6. Samples Copy linkLink copied to clipboard!
35.1.6. TestImageIntegration Copy linkLink copied to clipboard!
POST /v1/imageintegrations/test
TestImageIntegration checks if the given image integration is correctly configured, without using stored credential reconciliation.
35.1.6.1. Description Copy linkLink copied to clipboard!
35.1.6.2. Parameters Copy linkLink copied to clipboard!
35.1.6.2.1. Body Parameter Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
35.1.6.3. Return Type Copy linkLink copied to clipboard!
Object
35.1.6.4. Content Type Copy linkLink copied to clipboard!
- application/json
35.1.6.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
35.1.6.6. Samples Copy linkLink copied to clipboard!
35.1.7. TestUpdatedImageIntegration Copy linkLink copied to clipboard!
POST /v1/imageintegrations/test/updated
TestUpdatedImageIntegration checks if the given image integration is correctly configured, with optional stored credential reconciliation.
35.1.7.1. Description Copy linkLink copied to clipboard!
35.1.7.2. Parameters Copy linkLink copied to clipboard!
35.1.7.2.1. Body Parameter Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
35.1.7.3. Return Type Copy linkLink copied to clipboard!
Object
35.1.7.4. Content Type Copy linkLink copied to clipboard!
- application/json
35.1.7.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
35.1.7.6. Samples Copy linkLink copied to clipboard!
35.1.8. UpdateImageIntegration Copy linkLink copied to clipboard!
PATCH /v1/imageintegrations/{config.id}
UpdateImageIntegration modifies a given image integration, with optional stored credential reconciliation.
35.1.8.1. Description Copy linkLink copied to clipboard!
35.1.8.2. Parameters Copy linkLink copied to clipboard!
35.1.8.2.1. Path Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| config.id | X | null |
35.1.8.2.2. Body Parameter Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
35.1.8.3. Return Type Copy linkLink copied to clipboard!
Object
35.1.8.4. Content Type Copy linkLink copied to clipboard!
- application/json
35.1.8.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |