Skip to content
Connect an agent

Organisations

Write a test file

Writes plotwork-test.svg at the top of the destination and answers its link, or why it failed.

POST/orgs/{org}/storage/{id}/test

TL;DR

QuestionAnswer
What does it do?Write a test file.
What does it take?org, id in the path.
What does it return?Status 200 with a body of type StorageTest.
What can go wrong?401 not signed in; 403 not the owner or an admin (orgs.forbidden), the plan does not include it (plan.storage_not_included), or the origin may not make changes; 404 no such organisation or destination, or the caller is not a member; 429 too many requests; 503 sending to your storage is not available on this server (storage.unavailable). Every failure uses the one error envelope.

What it does

Writes plotwork-test.svg at the top of the destination and answers its link, or why it failed.

Path parameters

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.
idstringyesThe destination.

Responses

StatusMeaningBody
200How the test went.StorageTest
401Not signed in.ErrorResponse
403Not the owner or an admin (orgs.forbidden), the plan does not include it (plan.storage_not_included), or the origin may not make changes.ErrorResponse
404No such organisation or destination, or the caller is not a member.ErrorResponse
429Too many requests.ErrorResponse
503Sending to your storage is not available on this server (storage.unavailable).ErrorResponse

Response body

A 200 answer has the type StorageTest.

FieldTypeRequiredDescription
okbooleanyes
errorstring | nullyes
linkstring | nullyesWhere to see the sample file, in Drive or the cloud console.

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools