POST v1/{subscriptionID}/projects/{projectID}/archive?force={force}

Archives a project.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionID

The Circle subscription ID.

globally unique identifier

Required

projectID

The project ID to be archived.

globally unique identifier

Required

force

The value is 'true' if the project archiving should be forced in case of a failure on the uProduce side, and 'false' otherwise.

boolean

Optional. Default value is False

Body Parameters

None.

Response Information

Resource Description

Returns 'true' if the archiving succeeded, and 'false' otherwise.

boolean

Response Formats

application/json, text/json

Sample:
true