Create a project

put https://app.mk.io/api/v1/projects/:project_name

New project.

Authentication

Authorization Bearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_name string Required

Request

This endpoint expects an object.

displayNamestringRequired
Project display name.
locationNamestringRequired
The MK.IO location where this project's resources should be created.
paymentMethodIdstringRequiredformat: uuid
The payment method to use for this project.

Response

201 Created
kindstringOptional
The kind of record.
metadataobjectProjectMetadataSchemaOptional
Metadata.
Show 10 propertiesHide 10 properties
cloudobjectProjectMetadataCloudSchemaRequired
Cloud in which the project is hosted.
Show 3 propertiesHide 3 properties
displayNamestringRequired
The display name of the cloud.
idstringOptionalformat: uuid
The unique identifier of the cloud.
namestringRequired
The unique name of the cloud.
createdstringOptionalformat: date-time
The time when the resource was created
createdBystringOptionalformat: uuid
ID of the user who created the resource
createdByEmailstringOptional
Email of the user who created the resource
createdByIdstringRequiredformat: uuid
ID of the user who created the project.
createdByNamestringRequired
Name of the user who created the project.
displayNamestringOptional
The display name of the resource
idstringRequiredformat: uuid
The ID of the resource
namestringOptional
The name of the resource
updatedstringOptionalformat: date-time
The time when the resource was last updated
specobjectProjectSpecSchemaRequired
Specification.
Show 7 propertiesHide 7 properties
assignedPaymentMethodIdstring or nullRequiredformat: uuid
ID of the payment method assigned to the project.
displayNamestringRequired
Display name of the project.
isActivebooleanRequired
Is project active.
locationDisplayNamestringOptional
Display name of the location the project is in.
locationIdstringRequiredformat: uuid
ID of the location the project is in.
locationNamestringRequired
Name of the location the project is in.
namestringRequired
Name of the project.

Errors

400 Bad Request
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
401 Unauthorized
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
403 Forbidden
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
404 Not Found
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
429 Too Many Requests
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
500 Internal Server Error
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code