Add plugin

POST /api/v1/plugins

Api key Bearer

multipart/form-data

Body Required

name string Required

Name of the plugin
status string

Values are draft, unpublished, or published. Default value is draft.
language string Required

Language of your plugin default will be typescript

Values are typescript, python, java, php, go, or rust. Default value is typescript.
comments string

Additional comments regarding your plugin
description string

Description for the plugin
should_test boolean

Flag for the testing the plugin

Default value is false.
allowed_hostnames array[string]

Hostnames for plugin
file string(binary)
test_data string(binary)
test_url string Required

Test url for plugin

Responses

201 application/json

Plugin successfully registered.
Hide response attributes Show response attributes object
- is_error boolean Required
- message string Required
- correlator_id string Required
- data object Required
  
  Hide data attributes Show data attributes object
  
  id string Required
  
  name string Required
  
  status string Required
  
  code_path string Required
  
  language string Required
  
  comments string Required
  
  description string Required
  
  allowed_hostnames array[string] Required
  
  test_data string Required
  
  test_status string Required
  
  test_error string Required
  
  test_response string Required
  
  created_at string Required
  
  updated_at string Required
401 application/json

Login required to store an plugin
Hide response attributes Show response attributes object
- is_error boolean Required
- message string Required
- correlator_id string Required
- data object Required
422 application/json

Unprocessable entity - validation errors
Hide response attributes Show response attributes object
- is_error boolean Required
- message string Required
- correlator_id string Required
- data object Required

POST /api/v1/plugins

curl \
 -X POST https://api.crawlora.com/api/v1/plugins \
 -H "x-api-key: $API_KEY" \
 -H "Content-Type: multipart/form-data" \
 -F "name=string" \
 -F "status=draft" \
 -F "language=typescript" \
 -F "comments=string" \
 -F "description=string" \
 -F "should_test=false" \
 -F "allowed_hostnames[]=string" \
 -F "file=@file" \
 -F "test_data=@file" \
 -F "test_url=string"

Response examples (201)

{
  "is_error": true,
  "message": "string",
  "correlator_id": "string",
  "data": {
    "id": "string",
    "name": "string",
    "status": "string",
    "code_path": "string",
    "language": "string",
    "comments": "string",
    "description": "string",
    "allowed_hostnames": [
      "string"
    ],
    "test_data": "string",
    "test_status": "string",
    "test_error": "string",
    "test_response": "string",
    "created_at": "string",
    "updated_at": "string"
  }
}

Response examples (401)

{
  "is_error": true,
  "message": "string",
  "correlator_id": "string",
  "data": {}
}

Response examples (422)

{
  "is_error": true,
  "message": "string",
  "correlator_id": "string",
  "data": {}
}