Skip to main content

API Reference

This section provides detailed information about the CovertScript API.

Authentication​

All API requests require authentication using an API key:

curl -H "Authorization: Bearer YOUR_API_KEY" https://api.covertscript.com/v1/endpoint

Endpoints​

Scripts​

  • GET /v1/scripts - List all scripts
  • POST /v1/scripts - Create a new script
  • GET /v1/scripts/{id} - Get script details
  • PUT /v1/scripts/{id} - Update a script
  • DELETE /v1/scripts/{id} - Delete a script

Execution​

  • POST /v1/scripts/{id}/execute - Execute a script
  • GET /v1/executions/{id} - Get execution status
  • GET /v1/executions/{id}/logs - Get execution logs

Templates​

  • GET /v1/templates - List all templates
  • POST /v1/templates - Create a new template
  • GET /v1/templates/{id} - Get template details

Response Format​

All API responses are in JSON format:

{
  "success": true,
  "data": {
    // Response data
  },
  "error": null
}

Error Handling​

Errors are returned with appropriate HTTP status codes and error messages:

{
  "success": false,
  "data": null,
  "error": {
    "code": "ERROR_CODE",
    "message": "Error description"
  }
}