====Run API Function====

This function is used to trigger a capture run and is part of the [[API_documentation|Capture API]]

===Endpoint===

<code>
/capture/run
</code>

This may be a **GET** or **POST** request.

For example, the full URL on the server **mycompanyname** in site **default** would be....

  https://mycompanyname/s/default/capture/run?name=mycapturetype

===Parameters===

**format**: //json// or //xml//. \\
**name**: The code of the [[capture type|capture type]].

//Optional Parameters//

**debug**: If //true//, displays additional diagnostic information on the run.

===Response===

The response is in HTML format. It's largely diagnostic in nature. It can be disregarded or used in whatever format you see fit.