Create Customization
Request a customization in a catalog
Add a customization in a catalog uploading a tar.gz file. The id of the organization is fetched from CSP token.
Request
URI
POST
https://api.app-catalog.vmware.com/v1/catalogs/{catalog_id}/customizations
COPY
Path Parameters
Request Body
CustomizationCreate
of type(s)
multipart/form-data
Optional
Show optional properties
{
"file": "string"
}{
"filter": {
"base_image_id": "549cfa79-352c-4555-9d28-4442de551829",
"product_key": "apache_kafka",
"branch": "2"
},
"name": "my customization",
"description": "This is the customization required by my org",
"file": "string"
}
object
filter
Optional
It has information where a customization must be applied based in a combination of parameters
string
name
Optional
name
string
description
Optional
description
string As binary
As binary
file
Required
file
Responses
201
The customization has been created
Operation doesn't return any data structure
Response Headers
string
Location
Url to request the customization that has been created.
400
An error related to the customization
Returns
ConstraintsViolationsError
of type(s)
application/problem+json
This response body class contains all of the following:
InlineConstraintsViolationsError0
{
"type": "https://example.com/probs/validation-error",
"title": "Validation error",
"status": 400,
"detail": "There was an error validating the request",
"violations": [
{
"field": "amount",
"message": "It should be greater than zero"
}
]
}
array of
object
violations
Required
It represents a constraints violation error
403
The requesting user is not authorized to create new customizations
Returns
Error403
of type(s)
application/problem+json
This response body class contains all of the following:
InlineError4030
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit.",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}
404
The catalog is not found
Returns
Error404
of type(s)
application/problem+json
This response body class contains all of the following:
InlineError4040
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit.",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}
412
The application has not been released yet
Returns
Error412
of type(s)
application/problem+json
This response body class contains all of the following:
InlineError4120
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit.",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}
500
An internal server error object
Returns
Error500
of type(s)
application/problem+json
This response body class contains all of the following:
InlineError5000
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit.",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}
503
The server is temporarily unavailable
Returns
Error503
of type(s)
application/problem+json
This response body class contains all of the following:
InlineError5030
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit.",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: multipart/form-data' -d '{"file:"string"}' https://{api_host}/v1/catalogs/{catalog_id}/customizations