Walti.io REST API V1.0 Documentation

The REST API lets you interact with Walti.io from anything that can send an HTTP request. There are many things you can do with the REST API. For example:

  • A mobile website can access Walti.io data from Javascript.
  • A webserver can show data from Walti.io on a website.
  • You can download recent data to run your own custom analytics.
  • Applications written in any programming language can interact with data on Walti.io.

All API access is over HTTPS, and accessed via the https://app.walti.io domain. The relative path prefix /api/v1/ indicates that we are currently using version 1 of the API.

All API requests require an Api-Key header and an Api-Secret header. You can retrieve your organizations api key and secret if you click the Settings (設定) button on your targets index page (ターゲット一覧) (top page after login). The API tab contains your API key and secret.

Credentials

Show credentials with inactive payment account

Endpoint

GET /v1/me

Request

Route

GET /v1/me

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/me" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"b839b23b9a958ac752642eedfdcbf074"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 594bc2cb-fddd-4bba-8b27-2b6c76a0f0a8
X-Runtime: 0.011226
Content-Length: 171

Body

{
  "status": "active",
  "name": "optio",
  "description": null,
  "has_payment_account": false,
  "created_at": "2017-08-31T18:06:35.000+09:00",
  "updated_at": "2017-08-31T18:06:35.000+09:00"
}

Show credentials with no payment account

Endpoint

GET /v1/me

Request

Route

GET /v1/me

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/me" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"b839b23b9a958ac752642eedfdcbf074"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 2d361009-5f9f-4384-930a-8b36d01d05b2
X-Runtime: 0.005971
Content-Length: 171

Body

{
  "status": "active",
  "name": "optio",
  "description": null,
  "has_payment_account": false,
  "created_at": "2017-08-31T18:06:35.000+09:00",
  "updated_at": "2017-08-31T18:06:35.000+09:00"
}

Show credentials with valid payment account

Endpoint

GET /v1/me

Request

Route

GET /v1/me

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/me" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"015b4a2e016e2e852bccec9987921a4f"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e20275dd-f1a7-4acd-b552-b203d9c8de42
X-Runtime: 0.053090
Content-Length: 170

Body

{
  "status": "active",
  "name": "optio",
  "description": null,
  "has_payment_account": true,
  "created_at": "2017-08-31T18:06:35.000+09:00",
  "updated_at": "2017-08-31T18:06:35.000+09:00"
}

Plugins

Advanced schedule - daily at 01:30

Endpoint

PUT /v1/targets/:target_name/plugins/:plugin_name

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Body

plugin[schedule]=day&plugin[schedule_details][time]=01%3A30

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan" -d 'plugin[schedule]=day&plugin[schedule_details][time]=01%3A30' -X PUT \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"cd295de5bf550c7b9f3d0589ab0bfe7b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: aac2157d-7d6a-4b98-91b7-7d9f24d2c431
X-Runtime: 0.034489
Content-Length: 492

Body

{
  "name": "portscan",
  "category": "Firewall",
  "category_id": 4,
  "scan": {
    "id": 7,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2017-08-31T18:06:37.000+09:00",
    "updated_at": "2017-08-31T18:06:37.000+09:00",
    "portscan_summary": [

    ]
  },
  "schedule": "day",
  "schedule_details": {
    "time": "01:30"
  },
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null,
  "fee_api": 10,
  "fee_web": 30,
  "tickets_summary": {
    "count": 0,
    "max_severity": 0
  }
}

Advanced schedule - monthly on the 8th at 01:30

Endpoint

PUT /v1/targets/:target_name/plugins/:plugin_name

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Body

plugin[schedule]=month&plugin[schedule_details][time]=01%3A30&plugin[schedule_details][day]=8

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan" -d 'plugin[schedule]=month&plugin[schedule_details][time]=01%3A30&plugin[schedule_details][day]=8' -X PUT \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"cf742fc783d4a7836afdee7d2c6e5d5e"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: 319db37d-4b21-4c35-bca1-8c1aff2b08f8
X-Runtime: 0.041241
Content-Length: 503

Body

{
  "name": "portscan",
  "category": "Firewall",
  "category_id": 4,
  "scan": {
    "id": 13,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2017-08-31T18:06:38.000+09:00",
    "updated_at": "2017-08-31T18:06:38.000+09:00",
    "portscan_summary": [

    ]
  },
  "schedule": "month",
  "schedule_details": {
    "time": "01:30",
    "day": 8
  },
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null,
  "fee_api": 10,
  "fee_web": 30,
  "tickets_summary": {
    "count": 0,
    "max_severity": 0
  }
}

Advanced schedule - weekly on tuesday at 01:30

Endpoint

PUT /v1/targets/:target_name/plugins/:plugin_name

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Body

plugin[schedule]=week&plugin[schedule_details][time]=01%3A30&plugin[schedule_details][day_of_week]=2

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan" -d 'plugin[schedule]=week&plugin[schedule_details][time]=01%3A30&plugin[schedule_details][day_of_week]=2' -X PUT \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"129c1e7cfee5fc69eb88e0861afbb348"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: a4027b71-c15b-4928-863d-8fec185a9946
X-Runtime: 0.032175
Content-Length: 510

Body

{
  "name": "portscan",
  "category": "Firewall",
  "category_id": 4,
  "scan": {
    "id": 12,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2017-08-31T18:06:37.000+09:00",
    "updated_at": "2017-08-31T18:06:37.000+09:00",
    "portscan_summary": [

    ]
  },
  "schedule": "week",
  "schedule_details": {
    "time": "01:30",
    "day_of_week": 2
  },
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null,
  "fee_api": 10,
  "fee_web": 30,
  "tickets_summary": {
    "count": 0,
    "max_severity": 0
  }
}

Listing queued scans filtered by target

Endpoint

GET /v1/targets/:target_name/plugins

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

GET /v1/targets/127.0.0.1/plugins

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"9ceaaac8a2a3714eaf2d8bf9ddb3af1e"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 8340e6c6-0522-48d5-91cd-f1ca1a4d7102
X-Runtime: 0.244827
Content-Length: 1238

Body

[
  {
    "name": "portscan",
    "category": "Firewall",
    "category_id": 4,
    "scan": {
      "id": 1,
      "benchmark": 1000,
      "ip": "127.0.0.1",
      "message": "",
      "status": "ok",
      "status_color": "green",
      "result_status": 200,
      "result_env": {
      },
      "created_at": "2017-08-31T18:06:36.000+09:00",
      "updated_at": "2017-08-31T18:06:36.000+09:00",
      "portscan_summary": [

      ]
    },
    "schedule": "off",
    "schedule_details": null,
    "payment_option": "free_scan",
    "queued": false,
    "queued_at": null,
    "fee_api": 10,
    "fee_web": 30,
    "tickets_summary": {
      "count": 0,
      "max_severity": 0
    }
  },
  {
    "name": "o-saft",
    "category": "SSL/TLS",
    "category_id": 6,
    "scan": null,
    "schedule": "off",
    "schedule_details": null,
    "payment_option": "free_scan",
    "queued": false,
    "queued_at": null,
    "fee_api": 10,
    "fee_web": 30,
    "tickets_summary": {
      "count": 0,
      "max_severity": 0
    }
  },
  {
    "name": "nikto",
    "category": "Web Server",
    "category_id": 2,
    "scan": null,
    "schedule": "off",
    "schedule_details": null,
    "payment_option": "free_scan",
    "queued": true,
    "queued_at": "2017-08-31T18:06:36.000+09:00",
    "fee_api": 10,
    "fee_web": 30,
    "tickets_summary": {
      "count": 0,
      "max_severity": 0
    }
  },
  {
    "name": "skipfish",
    "category": "Web App",
    "category_id": 3,
    "scan": null,
    "schedule": "off",
    "schedule_details": null,
    "payment_option": "free_scan",
    "queued": false,
    "queued_at": null,
    "fee_api": 10,
    "fee_web": 30,
    "tickets_summary": {
      "count": 0,
      "max_severity": 0
    }
  }
]

Listing queued scans filtered by unavailable target

Endpoint

GET /v1/targets/:target_name/plugins

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

GET /v1/targets/unknown_target/plugins

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/unknown_target/plugins" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

400

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 9ea04fdf-a9ab-48dd-9a5b-8218c6eb5194
X-Runtime: 0.010034
Content-Length: 0

Show plugin filtered by target

Endpoint

GET /v1/targets/:target_name/plugins/:plugin_name

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

GET /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"a02756cfc4e2a5c75aeee7c38e0e19a8"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: d39f6d70-f668-44ba-9fc5-2540b5a7e291
X-Runtime: 0.029011
Content-Length: 480

Body

{
  "name": "portscan",
  "category": "Firewall",
  "category_id": 4,
  "scan": {
    "id": 4,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2017-08-31T18:06:36.000+09:00",
    "updated_at": "2017-08-31T18:06:36.000+09:00",
    "portscan_summary": [

    ]
  },
  "schedule": "off",
  "schedule_details": null,
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null,
  "fee_api": 10,
  "fee_web": 30,
  "tickets_summary": {
    "count": 0,
    "max_severity": 0
  }
}

Show plugin filtered by unknown target

Endpoint

GET /v1/targets/:target_name/plugins/:plugin_name

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

GET /v1/targets/unknown_target/plugins/portscan

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/unknown_target/plugins/portscan" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

400

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 36148d06-7d83-475a-8809-5f0b79908843
X-Runtime: 0.006496
Content-Length: 0

Show unavailable plugin filtered by target

Endpoint

GET /v1/targets/:target_name/plugins/:plugin_name

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

GET /v1/targets/127.0.0.1/plugins/unavailable_plugin

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/unavailable_plugin" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

400

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 286d9c80-70d1-48ce-b60b-d6c85c0e31a0
X-Runtime: 0.008794
Content-Length: 0

Update plugin schedule filtered by target with schedule day

Endpoint

PUT /v1/targets/:target_name/plugins/:plugin_name

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Body

plugin[schedule]=day

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan" -d 'plugin[schedule]=day' -X PUT \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"d2fb46d22fd84facad4216da7da5f25c"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: 1618f86f-0d34-4f5b-b532-c28f04327e5b
X-Runtime: 0.045567
Content-Length: 492

Body

{
  "name": "portscan",
  "category": "Firewall",
  "category_id": 4,
  "scan": {
    "id": 6,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2017-08-31T18:06:37.000+09:00",
    "updated_at": "2017-08-31T18:06:37.000+09:00",
    "portscan_summary": [

    ]
  },
  "schedule": "day",
  "schedule_details": {
    "time": "00:00"
  },
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null,
  "fee_api": 10,
  "fee_web": 30,
  "tickets_summary": {
    "count": 0,
    "max_severity": 0
  }
}

Update plugin schedule filtered by target with schedule month

Endpoint

PUT /v1/targets/:target_name/plugins/:plugin_name

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Body

plugin[schedule]=month

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan" -d 'plugin[schedule]=month' -X PUT \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"093541d17a5cc4ccf8f435649e5130fb"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: bd69eba8-24de-4daf-9500-269492bedabe
X-Runtime: 0.044980
Content-Length: 502

Body

{
  "name": "portscan",
  "category": "Firewall",
  "category_id": 4,
  "scan": {
    "id": 8,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2017-08-31T18:06:37.000+09:00",
    "updated_at": "2017-08-31T18:06:37.000+09:00",
    "portscan_summary": [

    ]
  },
  "schedule": "month",
  "schedule_details": {
    "time": "00:00",
    "day": 1
  },
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null,
  "fee_api": 10,
  "fee_web": 30,
  "tickets_summary": {
    "count": 0,
    "max_severity": 0
  }
}

Update plugin schedule filtered by target with schedule off

Endpoint

PUT /v1/targets/:target_name/plugins/:plugin_name

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Body

plugin[schedule]=off

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan" -d 'plugin[schedule]=off' -X PUT \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"401f619c728e2dc64593e0d207c76244"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: 878a0806-9b51-476a-bc25-fd883b63659a
X-Runtime: 0.039222
Content-Length: 480

Body

{
  "name": "portscan",
  "category": "Firewall",
  "category_id": 4,
  "scan": {
    "id": 9,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2017-08-31T18:06:37.000+09:00",
    "updated_at": "2017-08-31T18:06:37.000+09:00",
    "portscan_summary": [

    ]
  },
  "schedule": "off",
  "schedule_details": null,
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null,
  "fee_api": 10,
  "fee_web": 30,
  "tickets_summary": {
    "count": 0,
    "max_severity": 0
  }
}

Update plugin schedule filtered by target with schedule unknown

Endpoint

PUT /v1/targets/:target_name/plugins/:plugin_name

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Body

plugin[schedule]=unknown

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan" -d 'plugin[schedule]=unknown' -X PUT \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

422

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=PUT; path=/
X-Request-Id: d460429b-1d25-4caf-873e-ab714d21b783
X-Runtime: 0.013902
Content-Length: 91

Body

{
  "message": "Only off, day, week and month are supported in the plugin[schedule] parameter"
}

Update plugin schedule filtered by target with schedule week

Endpoint

PUT /v1/targets/:target_name/plugins/:plugin_name

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Body

plugin[schedule]=week

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan" -d 'plugin[schedule]=week' -X PUT \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"24ed17a89377c58b12ea78dc34f43818"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: 38818f4e-c1f7-4536-9998-3c3f07ee2939
X-Runtime: 0.046567
Content-Length: 510

Body

{
  "name": "portscan",
  "category": "Firewall",
  "category_id": 4,
  "scan": {
    "id": 15,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2017-08-31T18:06:38.000+09:00",
    "updated_at": "2017-08-31T18:06:38.000+09:00",
    "portscan_summary": [

    ]
  },
  "schedule": "week",
  "schedule_details": {
    "time": "00:00",
    "day_of_week": 0
  },
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null,
  "fee_api": 10,
  "fee_web": 30,
  "tickets_summary": {
    "count": 0,
    "max_severity": 0
  }
}

Update plugin schedule filtered by unknown target

Endpoint

PUT /v1/targets/:target_name/plugins/:plugin_name

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

PUT /v1/targets/unknown_target/plugins/portscan

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/unknown_target/plugins/portscan" -d '' -X PUT \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

400

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=PUT; path=/
X-Request-Id: f24c9a88-8162-4dfd-b542-e32ae1c61708
X-Runtime: 0.018213
Content-Length: 0

Update unavailable plugin schedule filtered by target

Endpoint

PUT /v1/targets/:target_name/plugins/:plugin_name

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/unavailable_plugin

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/unavailable_plugin" -d '' -X PUT \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

400

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=PUT; path=/
X-Request-Id: c41a4997-f6ae-40ca-89fd-f12db6c90b6d
X-Runtime: 0.007670
Content-Length: 0

Scans

Listing queued scans filtered by target

Endpoint

GET /v1/targets/:target_name/scans

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

GET /v1/targets/127.0.0.1/scans

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/scans" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"2675b0ba70427ac20c44f8512188454f"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e1d18670-e056-4940-acbb-1eb87ae1483d
X-Runtime: 0.025905
Content-Length: 640

Body

[
  {
    "id": 41,
    "benchmark": 1000,
    "plugin": "o-saft",
    "plugin_category": "SSL/TLS",
    "target": "127.0.0.1",
    "ip": "127.0.0.1",
    "message": null,
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "result_body": "OK",
    "created_at": "2017-08-31T18:06:40.000+09:00",
    "updated_at": "2017-08-31T18:06:40.000+09:00"
  },
  {
    "id": 40,
    "benchmark": 1000,
    "plugin": "portscan",
    "plugin_category": "Firewall",
    "target": "127.0.0.1",
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "result_body": "OK",
    "created_at": "2017-08-31T18:06:40.000+09:00",
    "updated_at": "2017-08-31T18:06:40.000+09:00",
    "portscan_summary": [

    ]
  }
]

Listing queued scans filtered by target and plugin

Endpoint

GET /v1/targets/:target_name/plugins/:plugin_name/scans

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

GET /v1/targets/127.0.0.1/plugins/portscan/scans

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"e983cad61204018e80149077712d445c"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 93eaf8b4-ef4e-43ab-866f-9689a7347c48
X-Runtime: 0.017959
Content-Length: 332

Body

[
  {
    "id": 42,
    "benchmark": 1000,
    "plugin": "portscan",
    "plugin_category": "Firewall",
    "target": "127.0.0.1",
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "result_body": "OK",
    "created_at": "2017-08-31T18:06:41.000+09:00",
    "updated_at": "2017-08-31T18:06:41.000+09:00",
    "portscan_summary": [

    ]
  }
]

Listing scans

Endpoint

GET /v1/scans

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

GET /v1/scans

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/scans" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"8e35de8aca34e94e44913fcb35058379"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: b1b33ea1-a787-4fa4-af76-e7f5f8b7e50e
X-Runtime: 0.024936
Content-Length: 640

Body

[
  {
    "id": 39,
    "benchmark": 1000,
    "plugin": "o-saft",
    "plugin_category": "SSL/TLS",
    "target": "127.0.0.1",
    "ip": "127.0.0.1",
    "message": null,
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "result_body": "OK",
    "created_at": "2017-08-31T18:06:40.000+09:00",
    "updated_at": "2017-08-31T18:06:40.000+09:00"
  },
  {
    "id": 38,
    "benchmark": 1000,
    "plugin": "portscan",
    "plugin_category": "Firewall",
    "target": "127.0.0.1",
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "result_body": "OK",
    "created_at": "2017-08-31T18:06:40.000+09:00",
    "updated_at": "2017-08-31T18:06:40.000+09:00",
    "portscan_summary": [

    ]
  }
]

Queue scan

Endpoint

POST /v1/targets/:target_name/plugins/:plugin_name/scans

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

POST /v1/targets/127.0.0.1/plugins/portscan/scans

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans" -d '' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

201

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=POST; path=/
X-Request-Id: 223da48d-24c6-4905-aee1-23d7185cad36
X-Runtime: 0.052809
Content-Length: 0

Queue scan with skipfish with force

Endpoint

POST /v1/targets/:target_name/plugins/:plugin_name/scans

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

POST /v1/targets/127.0.0.1/plugins/skipfish/scans

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Body

force=true

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/skipfish/scans" -d 'force=true' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

201

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=POST; path=/
X-Request-Id: 766386ae-dcaf-4bd3-a881-0950d18650fc
X-Runtime: 0.081687
Content-Length: 0

Queue scan with skipfish without force

Endpoint

POST /v1/targets/:target_name/plugins/:plugin_name/scans

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

POST /v1/targets/127.0.0.1/plugins/skipfish/scans

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/skipfish/scans" -d '' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

402

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=POST; path=/
X-Request-Id: 861fb04b-583b-4b56-8ed1-4df4f67affd2
X-Runtime: 0.008573
Content-Length: 0

Show finished scan

Endpoint

GET /v1/scans/:scan_id

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

GET /v1/scans/34

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/scans/34" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"10da28ccf5135ded547c7eb010498e06"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 85e86725-c50a-4047-8676-6af7505febbe
X-Runtime: 0.015359
Content-Length: 330

Body

{
  "id": 34,
  "benchmark": 1000,
  "plugin": "portscan",
  "plugin_category": "Firewall",
  "target": "127.0.0.1",
  "ip": "127.0.0.1",
  "message": "",
  "status": "ok",
  "status_color": "green",
  "result_status": 200,
  "result_env": {
  },
  "result_body": "OK",
  "created_at": "2017-08-31T18:06:40.000+09:00",
  "updated_at": "2017-08-31T18:06:40.000+09:00",
  "portscan_summary": [

  ]
}

Show queued scan

Endpoint

GET /v1/scans/:scan_id

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

GET /v1/scans/33

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/scans/33" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"0849db51e567939cd3b6415b9368610f"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c10a63ef-e4bc-4ef2-b2e7-cd1f272214c1
X-Runtime: 0.020158
Content-Length: 307

Body

{
  "id": 33,
  "benchmark": 1000,
  "plugin": "o-saft",
  "plugin_category": "SSL/TLS",
  "target": "127.0.0.1",
  "ip": "127.0.0.1",
  "message": null,
  "status": "ok",
  "status_color": "green",
  "result_status": 200,
  "result_env": {
  },
  "result_body": "OK",
  "created_at": "2017-08-31T18:06:40.000+09:00",
  "updated_at": "2017-08-31T18:06:40.000+09:00"
}

Show queued scan filtered by target

Endpoint

GET /v1/targets/:target_name/scans/:scan_id

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

GET /v1/targets/127.0.0.1/scans/36

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/scans/36" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"3c30aa0b27d7b01f1e1514b4ce02cec8"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: dc9ff2c0-9782-4171-b9f7-99a6f2a1401f
X-Runtime: 0.017312
Content-Length: 330

Body

{
  "id": 36,
  "benchmark": 1000,
  "plugin": "portscan",
  "plugin_category": "Firewall",
  "target": "127.0.0.1",
  "ip": "127.0.0.1",
  "message": "",
  "status": "ok",
  "status_color": "green",
  "result_status": 200,
  "result_env": {
  },
  "result_body": "OK",
  "created_at": "2017-08-31T18:06:40.000+09:00",
  "updated_at": "2017-08-31T18:06:40.000+09:00",
  "portscan_summary": [

  ]
}

Show queued scan filtered by target and plugin

Endpoint

GET /v1/targets/:target_name/plugins/:plugin_name/scans/:scan_id

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

GET /v1/targets/127.0.0.1/plugins/portscan/scans/44

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans/44" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"ae2da4d5c8c6aacb3d2be48d9893f2cd"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 238c5149-34b8-4845-88fa-9835e21ee4e6
X-Runtime: 0.017425
Content-Length: 330

Body

{
  "id": 44,
  "benchmark": 1000,
  "plugin": "portscan",
  "plugin_category": "Firewall",
  "target": "127.0.0.1",
  "ip": "127.0.0.1",
  "message": "",
  "status": "ok",
  "status_color": "green",
  "result_status": 200,
  "result_env": {
  },
  "result_body": "OK",
  "created_at": "2017-08-31T18:06:41.000+09:00",
  "updated_at": "2017-08-31T18:06:41.000+09:00",
  "portscan_summary": [

  ]
}

Try queuing scan when already queued

Endpoint

POST /v1/targets/:target_name/plugins/:plugin_name/scans

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

POST /v1/targets/127.0.0.1/plugins/portscan/scans

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans" -d '' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

208

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=POST; path=/
X-Request-Id: 5756617d-797a-4741-b8e5-09b6d0a7de68
X-Runtime: 0.053921
Content-Length: 0

Try queuing scan when target is not active

Endpoint

POST /v1/targets/:target_name/plugins/:plugin_name/scans

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

POST /v1/targets/127.0.0.1/plugins/portscan/scans

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans" -d '' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

403

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=POST; path=/
X-Request-Id: 244bd4a8-7909-4265-b4c2-beb55c9521f1
X-Runtime: 0.015325
Content-Length: 0

Try queuing scan without payment information unsufficient mission discount

Endpoint

POST /v1/targets/:target_name/plugins/:plugin_name/scans

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

POST /v1/targets/127.0.0.1/plugins/portscan/scans

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans" -d '' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

402

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=POST; path=/
X-Request-Id: 20d13e00-a7d9-4ce6-882a-baf0a7bce502
X-Runtime: 0.024642
Content-Length: 0

Try queuing scan without payment information with sufficient mission discount

Endpoint

POST /v1/targets/:target_name/plugins/:plugin_name/scans

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

POST /v1/targets/127.0.0.1/plugins/portscan/scans

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans" -d '' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

201

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=POST; path=/
X-Request-Id: 9ce0cd47-87f1-4921-98f5-1bc5fcae6ec2
X-Runtime: 0.086888
Content-Length: 0

Try showing not existing scan

Endpoint

GET /v1/scans/:scan_id

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, o-saft, nikto, skipfish, wpscan)
scan_id Scan UUID

Request

Route

GET /v1/scans/MY-FlzVr0etBgyjbaygJ5A

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/scans/MY-FlzVr0etBgyjbaygJ5A" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

400

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
X-Request-Id: cedc652c-58e8-4564-8056-b2128033f458
X-Runtime: 0.010864
Content-Length: 0

Targets

Create new target

Endpoint

POST /v1/targets

Parameters

Name Description
target_name Domain name or IP
target[name] required Target domain name or IP
target[description] Target description

Request

Route

POST /v1/targets

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Body

target[name]=github.com&target[description]=Description

Curl

curl "https://api.walti.io/v1/targets" -d 'target[name]=github.com&target[description]=Description' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

201

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Location: http://example.org/targets/github.com
Content-Type: application/json; charset=utf-8
ETag: W/"e6e0561eb48f53d4187e5e1f25157754"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=POST; path=/
X-Request-Id: 466ba5a6-192d-48d2-8e1a-6dc05417ccce
X-Runtime: 0.221024
Content-Length: 2210

Body

{
  "status": "unchecked",
  "name": "github.com",
  "description": "Description",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=12e41bff96ca4a19aab7a9a067d3e815",
  "ownership": "unknown",
  "plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "o-saft",
      "category": "SSL/TLS",
      "category_id": 6,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "visible_plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "ports_confirmed": false,
  "ports_registered": false,
  "free_amount": 10,
  "free_balance": 10,
  "coupon_amount": 0,
  "coupon_balance": 0,
  "queued_amount": 0,
  "ip_addresses": [
    "192.30.255.112",
    "192.30.255.113"
  ],
  "created_at": "2017-08-31T18:06:45.000+09:00",
  "updated_at": "2017-08-31T18:06:45.000+09:00"
}

Listing targets

Endpoint

GET /v1/targets

Parameters

Name Description
target_name Domain name or IP

Request

Route

GET /v1/targets

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"d805ab47d76fba2a0beae9a504a1bc79"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c90befa0-cd5c-47a0-aa5c-c04b434245c5
X-Runtime: 0.172340
Content-Length: 4885

Body

[
  {
    "status": "active",
    "name": "127.0.0.1",
    "description": "",
    "label": "",
    "ownership_url": "http://walti.dev/ownershipfiles?key=5d8241a7be5a498ba57e5d1e1144590a",
    "ownership": "confirmed",
    "plugins": [
      {
        "name": "portscan",
        "category": "Firewall",
        "category_id": 4,
        "scan": {
          "id": 49,
          "benchmark": 1000,
          "ip": "127.0.0.1",
          "message": "",
          "status": "ok",
          "status_color": "green",
          "result_status": 200,
          "result_env": {
          },
          "created_at": "2017-08-31T18:06:43.000+09:00",
          "updated_at": "2017-08-31T18:06:43.000+09:00",
          "portscan_summary": [

          ]
        },
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null,
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      },
      {
        "name": "o-saft",
        "category": "SSL/TLS",
        "category_id": 6,
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null,
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      },
      {
        "name": "nikto",
        "category": "Web Server",
        "category_id": 2,
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": true,
        "queued_at": "2017-08-31T18:06:43.000+09:00",
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      },
      {
        "name": "skipfish",
        "category": "Web App",
        "category_id": 3,
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null,
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      }
    ],
    "visible_plugins": [
      {
        "name": "portscan",
        "category": "Firewall",
        "category_id": 4,
        "scan": {
          "id": 49,
          "benchmark": 1000,
          "ip": "127.0.0.1",
          "message": "",
          "status": "ok",
          "status_color": "green",
          "result_status": 200,
          "result_env": {
          },
          "created_at": "2017-08-31T18:06:43.000+09:00",
          "updated_at": "2017-08-31T18:06:43.000+09:00",
          "portscan_summary": [

          ]
        },
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null,
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      },
      {
        "name": "nikto",
        "category": "Web Server",
        "category_id": 2,
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": true,
        "queued_at": "2017-08-31T18:06:43.000+09:00",
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      },
      {
        "name": "skipfish",
        "category": "Web App",
        "category_id": 3,
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null,
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      }
    ],
    "ports_confirmed": false,
    "ports_registered": false,
    "free_amount": 10,
    "free_balance": 10,
    "coupon_amount": 0,
    "coupon_balance": 0,
    "queued_amount": 0,
    "ip_addresses": [
      "127.0.0.1"
    ],
    "created_at": "2017-08-31T18:06:43.000+09:00",
    "updated_at": "2017-08-31T18:06:43.000+09:00"
  },
  {
    "status": "active",
    "name": "google.com",
    "description": "",
    "label": "",
    "ownership_url": "http://walti.dev/ownershipfiles?key=5dda47228d1f402f8e19256f7722393e",
    "ownership": "confirmed",
    "plugins": [
      {
        "name": "portscan",
        "category": "Firewall",
        "category_id": 4,
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null,
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      },
      {
        "name": "o-saft",
        "category": "SSL/TLS",
        "category_id": 6,
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null,
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      },
      {
        "name": "nikto",
        "category": "Web Server",
        "category_id": 2,
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null,
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      },
      {
        "name": "skipfish",
        "category": "Web App",
        "category_id": 3,
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null,
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      }
    ],
    "visible_plugins": [
      {
        "name": "portscan",
        "category": "Firewall",
        "category_id": 4,
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null,
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      },
      {
        "name": "nikto",
        "category": "Web Server",
        "category_id": 2,
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null,
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      },
      {
        "name": "skipfish",
        "category": "Web App",
        "category_id": 3,
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null,
        "fee_api": 10,
        "fee_web": 30,
        "tickets_summary": {
          "count": 0,
          "max_severity": 0
        }
      }
    ],
    "ports_confirmed": false,
    "ports_registered": false,
    "free_amount": 10,
    "free_balance": 10,
    "coupon_amount": 0,
    "coupon_balance": 0,
    "queued_amount": 0,
    "ip_addresses": [
      "216.58.197.174"
    ],
    "created_at": "2017-08-31T18:06:43.000+09:00",
    "updated_at": "2017-08-31T18:06:43.000+09:00"
  }
]

Non existing target

Endpoint

GET /v1/targets/:target_name

Parameters

Name Description
target_name Domain name or IP

Request

Route

GET /v1/targets/non_existing

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/non_existing" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

400

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
X-Request-Id: a990df39-e494-4509-8d86-57b73ea16c8f
X-Runtime: 0.026615
Content-Length: 0

Show target

Endpoint

GET /v1/targets/:target_name

Parameters

Name Description
target_name Domain name or IP

Request

Route

GET /v1/targets/127.0.0.1

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"19e0ca0c909be8f2f4e19bea3caf4f30"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: a5731ba8-18cd-4be3-8ed4-21b4561442a5
X-Runtime: 0.100207
Content-Length: 2701

Body

{
  "status": "active",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=57fe6a902f88442e8ed70cd30315cb33",
  "ownership": "confirmed",
  "plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": {
        "id": 47,
        "benchmark": 1000,
        "ip": "127.0.0.1",
        "message": "",
        "status": "ok",
        "status_color": "green",
        "result_status": 200,
        "result_env": {
        },
        "created_at": "2017-08-31T18:06:41.000+09:00",
        "updated_at": "2017-08-31T18:06:41.000+09:00",
        "portscan_summary": [

        ]
      },
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "o-saft",
      "category": "SSL/TLS",
      "category_id": 6,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": true,
      "queued_at": "2017-08-31T18:06:41.000+09:00",
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "visible_plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": {
        "id": 47,
        "benchmark": 1000,
        "ip": "127.0.0.1",
        "message": "",
        "status": "ok",
        "status_color": "green",
        "result_status": 200,
        "result_env": {
        },
        "created_at": "2017-08-31T18:06:41.000+09:00",
        "updated_at": "2017-08-31T18:06:41.000+09:00",
        "portscan_summary": [

        ]
      },
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": true,
      "queued_at": "2017-08-31T18:06:41.000+09:00",
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "ports_confirmed": false,
  "ports_registered": false,
  "free_amount": 10,
  "free_balance": 10,
  "coupon_amount": 0,
  "coupon_balance": 0,
  "queued_amount": 0,
  "ip_addresses": [
    "127.0.0.1"
  ],
  "created_at": "2017-08-31T18:06:41.000+09:00",
  "updated_at": "2017-08-31T18:06:41.000+09:00"
}

Start activating a target

Endpoint

POST /v1/targets/:target_name/activate

Parameters

Name Description
target_name Domain name or IP

Request

Route

POST /v1/targets/127.0.0.1/activate

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -d '' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

202

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Location: http://example.org/targets/127.0.0.1
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=POST; path=/
X-Request-Id: 1c02c834-6c6a-4e41-b22e-69170173874f
X-Runtime: 0.185413
Content-Length: 2175

Body

{
  "status": "unchecked",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=4bafd29beff94cc8ab2872fdd05cd35c",
  "ownership": "queued",
  "plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "o-saft",
      "category": "SSL/TLS",
      "category_id": 6,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "visible_plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "ports_confirmed": false,
  "ports_registered": false,
  "free_amount": 10,
  "free_balance": 10,
  "coupon_amount": 0,
  "coupon_balance": 0,
  "queued_amount": 0,
  "ip_addresses": [
    "127.0.0.1"
  ],
  "created_at": "2017-08-31T18:06:41.000+09:00",
  "updated_at": "2017-08-31T18:06:41.000+09:00"
}

Target activation failed

Endpoint

GET /v1/targets/:target_name/activate

Parameters

Name Description
target_name Domain name or IP

Request

Route

GET /v1/targets/127.0.0.1/activate

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

422

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 470e0c5c-47b6-4659-8e93-9204b2e6dad4
X-Runtime: 0.099200
Content-Length: 2176

Body

{
  "status": "unchecked",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=b15477598c214c729a2d2facea38f78d",
  "ownership": "unknown",
  "plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "o-saft",
      "category": "SSL/TLS",
      "category_id": 6,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "visible_plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "ports_confirmed": false,
  "ports_registered": false,
  "free_amount": 10,
  "free_balance": 10,
  "coupon_amount": 0,
  "coupon_balance": 0,
  "queued_amount": 0,
  "ip_addresses": [
    "127.0.0.1"
  ],
  "created_at": "2017-08-31T18:06:44.000+09:00",
  "updated_at": "2017-08-31T18:06:44.000+09:00"
}

Target activation succeeded

Endpoint

GET /v1/targets/:target_name/activate

Parameters

Name Description
target_name Domain name or IP

Request

Route

GET /v1/targets/127.0.0.1/activate

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

201

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"147623e2016cc31d167931ea149ab999"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c3eaf1b3-39f0-4b0d-ab9a-2e8db5b4e6c0
X-Runtime: 0.083706
Content-Length: 2175

Body

{
  "status": "active",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=eaa5deccd2294c579e2e91b3cc503959",
  "ownership": "confirmed",
  "plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "o-saft",
      "category": "SSL/TLS",
      "category_id": 6,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "visible_plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "ports_confirmed": false,
  "ports_registered": false,
  "free_amount": 10,
  "free_balance": 10,
  "coupon_amount": 0,
  "coupon_balance": 0,
  "queued_amount": 0,
  "ip_addresses": [
    "127.0.0.1"
  ],
  "created_at": "2017-08-31T18:06:43.000+09:00",
  "updated_at": "2017-08-31T18:06:44.000+09:00"
}

Target activation succeeded

Endpoint

GET /v1/targets/:target_name/activate

Parameters

Name Description
target_name Domain name or IP

Request

Route

GET /v1/targets/127.0.0.1/activate

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

201

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"147623e2016cc31d167931ea149ab999"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c3eaf1b3-39f0-4b0d-ab9a-2e8db5b4e6c0
X-Runtime: 0.083706
Content-Length: 2175

Body

{
  "status": "active",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=eaa5deccd2294c579e2e91b3cc503959",
  "ownership": "confirmed",
  "plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "o-saft",
      "category": "SSL/TLS",
      "category_id": 6,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "visible_plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "ports_confirmed": false,
  "ports_registered": false,
  "free_amount": 10,
  "free_balance": 10,
  "coupon_amount": 0,
  "coupon_balance": 0,
  "queued_amount": 0,
  "ip_addresses": [
    "127.0.0.1"
  ],
  "created_at": "2017-08-31T18:06:43.000+09:00",
  "updated_at": "2017-08-31T18:06:44.000+09:00"
}

Try activating already activated target

Endpoint

POST /v1/targets/:target_name/activate

Parameters

Name Description
target_name Domain name or IP

Request

Route

POST /v1/targets/127.0.0.1/activate

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -d '' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

201

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Location: http://example.org/targets/127.0.0.1
Content-Type: application/json; charset=utf-8
ETag: W/"5d09d06cedb4f89fe0bf0d74a94e0bea"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=POST; path=/
X-Request-Id: cdef7992-4e66-44d7-b5b0-4f4fee8f3519
X-Runtime: 0.093800
Content-Length: 2175

Body

{
  "status": "active",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=7e90eb577d4a45b3abe92f83803dc89a",
  "ownership": "confirmed",
  "plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "o-saft",
      "category": "SSL/TLS",
      "category_id": 6,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "visible_plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "ports_confirmed": false,
  "ports_registered": false,
  "free_amount": 10,
  "free_balance": 10,
  "coupon_amount": 0,
  "coupon_balance": 0,
  "queued_amount": 0,
  "ip_addresses": [
    "127.0.0.1"
  ],
  "created_at": "2017-08-31T18:06:42.000+09:00",
  "updated_at": "2017-08-31T18:06:42.000+09:00"
}

Try activating not existing target

Endpoint

POST /v1/targets/:target_name/activate

Parameters

Name Description
target_name Domain name or IP

Request

Route

POST /v1/targets/non_existing/activate

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/non_existing/activate" -d '' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

400

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=POST; path=/
X-Request-Id: 5c8265cf-2b3a-46ec-8490-f2548e2dc1ad
X-Runtime: 0.005549
Content-Length: 0

Try activation on a target, which is already queued for activation

Endpoint

POST /v1/targets/:target_name/activate

Parameters

Name Description
target_name Domain name or IP

Request

Route

POST /v1/targets/127.0.0.1/activate

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -d '' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

202

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Location: http://example.org/targets/127.0.0.1
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=POST; path=/
X-Request-Id: 3ebc0ffe-28dc-40ed-963e-3a3c5e1a2ce3
X-Runtime: 0.097711
Content-Length: 2175

Body

{
  "status": "unchecked",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=180c8cb4bf7c4099821440b1298c6e7c",
  "ownership": "queued",
  "plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "o-saft",
      "category": "SSL/TLS",
      "category_id": 6,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "visible_plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "ports_confirmed": false,
  "ports_registered": false,
  "free_amount": 10,
  "free_balance": 10,
  "coupon_amount": 0,
  "coupon_balance": 0,
  "queued_amount": 0,
  "ip_addresses": [
    "127.0.0.1"
  ],
  "created_at": "2017-08-31T18:06:42.000+09:00",
  "updated_at": "2017-08-31T18:06:42.000+09:00"
}

Try create existing target

Endpoint

POST /v1/targets

Parameters

Name Description
target_name Domain name or IP
target[name] required Target domain name or IP
target[description] Target description

Request

Route

POST /v1/targets

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Body

target[name]=127.0.0.1

Curl

curl "https://api.walti.io/v1/targets" -d 'target[name]=127.0.0.1' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

201

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Location: http://example.org/targets/127.0.0.1
Content-Type: application/json; charset=utf-8
ETag: W/"32b13de482489dccbaba112f26558047"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=POST; path=/
X-Request-Id: ad3f32d4-34df-4088-b4c0-5515c30bc897
X-Runtime: 0.183738
Content-Length: 2175

Body

{
  "status": "active",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=a9e88bcb7c0d4ec3b466200271a4ee07",
  "ownership": "confirmed",
  "plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "o-saft",
      "category": "SSL/TLS",
      "category_id": 6,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "visible_plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "ports_confirmed": false,
  "ports_registered": false,
  "free_amount": 10,
  "free_balance": 10,
  "coupon_amount": 0,
  "coupon_balance": 0,
  "queued_amount": 0,
  "ip_addresses": [
    "127.0.0.1"
  ],
  "created_at": "2017-08-31T18:06:45.000+09:00",
  "updated_at": "2017-08-31T18:06:45.000+09:00"
}

Try create invalid target

Endpoint

POST /v1/targets

Parameters

Name Description
target_name Domain name or IP
target[name] required Target domain name or IP
target[description] Target description

Request

Route

POST /v1/targets

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Body

target[name]=

Curl

curl "https://api.walti.io/v1/targets" -d 'target[name]=' -X POST \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Status

422

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Set-Cookie: request_method=POST; path=/
X-Request-Id: 6bfdd350-e160-4ad4-9ec3-065f05574745
X-Runtime: 0.014185
Content-Length: 40

Body

{
  "message": "Target name can't be blank"
}

Try to receive activation status for not existing target

Endpoint

GET /v1/targets/:target_name/activate

Parameters

Name Description
target_name Domain name or IP

Request

Route

GET /v1/targets/non_existing/activate

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/non_existing/activate" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

400

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 095cb70a-0f2b-4e4a-b38d-cde3817e6873
X-Runtime: 0.007659
Content-Length: 0

Wait for activation of a target

Endpoint

GET /v1/targets/:target_name/activate

Parameters

Name Description
target_name Domain name or IP

Request

Route

GET /v1/targets/127.0.0.1/activate

Headers

Api-Key: oIesfQ4AQfv08Ud2CdvDeA
Api-Secret: ALC0OZIV7R8ynwcP-s85Rg

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -X GET \
	-H "Api-Key: oIesfQ4AQfv08Ud2CdvDeA" \
	-H "Api-Secret: ALC0OZIV7R8ynwcP-s85Rg"

Response

Status

202

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 52068ff1-08f7-426d-b39c-885713d57ac9
X-Runtime: 0.099476
Content-Length: 2175

Body

{
  "status": "unchecked",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=01659fca385544d4ba087af26c7a9e57",
  "ownership": "queued",
  "plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "o-saft",
      "category": "SSL/TLS",
      "category_id": 6,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "visible_plugins": [
    {
      "name": "portscan",
      "category": "Firewall",
      "category_id": 4,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "nikto",
      "category": "Web Server",
      "category_id": 2,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    },
    {
      "name": "skipfish",
      "category": "Web App",
      "category_id": 3,
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null,
      "fee_api": 10,
      "fee_web": 30,
      "tickets_summary": {
        "count": 0,
        "max_severity": 0
      }
    }
  ],
  "ports_confirmed": false,
  "ports_registered": false,
  "free_amount": 10,
  "free_balance": 10,
  "coupon_amount": 0,
  "coupon_balance": 0,
  "queued_amount": 0,
  "ip_addresses": [
    "127.0.0.1"
  ],
  "created_at": "2017-08-31T18:06:44.000+09:00",
  "updated_at": "2017-08-31T18:06:44.000+09:00"
}