Update plugin

PUT /api/v1/plugins/{id}

Api key Bearer

Path parameters

id string Required

ID of the plugin to update

multipart/form-data

Body Required

name string
status string

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

Additional comments regarding your plugin
should_test boolean Required

Flag for the testing the plugin

Default value is false.
allowed_hostnames array[string]
file string(binary)
test_data string(binary)

Responses

200 application/json

Plugin updated successfully
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 update plugin
Hide response attributes Show response attributes object
- is_error boolean Required
- message string Required
- correlator_id string Required
- data object Required
404 application/json

Plugin not found
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

PUT /api/v1/plugins/{id}

curl \
 --request PUT 'https://api.crawlora.com/api/v1/plugins/{id}' \
 --header "x-api-key: $API_KEY" \
 --header "Content-Type: multipart/form-data" \
 --form "name=string" \
 --form "status=draft" \
 --form "comments=string" \
 --form "should_test=false" \
 --form "allowed_hostnames[]=string" \
 --form "file=@file" \
 --form "test_data=@file"

Response examples (200)

{
  "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 (404)

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

Response examples (422)

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