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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/me" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"69cb7b31605425d3d69b971439f092d6"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 7cb093c1-b875-4861-99f2-b7003a6b5b87
X-Runtime: 0.012169
Content-Length: 174

Body

{
  "status": "active",
  "name": "possimus",
  "description": null,
  "has_payment_account": false,
  "created_at": "2015-05-28T01:21:54.000+09:00",
  "updated_at": "2015-05-28T01:21:54.000+09:00"
}

Show credentials with no payment account

Endpoint

GET /v1/me

Request

Route

GET /v1/me

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/me" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"69cb7b31605425d3d69b971439f092d6"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 849f3c01-f27a-4bac-bf51-c6ece0151de8
X-Runtime: 0.150082
Content-Length: 174

Body

{
  "status": "active",
  "name": "possimus",
  "description": null,
  "has_payment_account": false,
  "created_at": "2015-05-28T01:21:54.000+09:00",
  "updated_at": "2015-05-28T01:21:54.000+09:00"
}

Show credentials with valid payment account

Endpoint

GET /v1/me

Request

Route

GET /v1/me

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/me" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"5e69f466437cfe84d6cd6ff771f4d72a"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 91e92adc-1ed4-40f1-bead-e3e076c4e153
X-Runtime: 0.008538
Content-Length: 173

Body

{
  "status": "active",
  "name": "possimus",
  "description": null,
  "has_payment_account": true,
  "created_at": "2015-05-28T01:21:54.000+09:00",
  "updated_at": "2015-05-28T01:21:54.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, sslyze, nikto, skipfish)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

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: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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/"8a2dc98a7594efb476f760a0b7d10043"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: 847f2dfd-4038-478b-903d-276506c0fb3c
X-Runtime: 0.033969
Content-Length: 360

Body

{
  "name": "portscan",
  "scan": {
    "id": 13,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2015-05-28T01:21:56.000+09:00",
    "updated_at": "2015-05-28T01:21:56.000+09:00"
  },
  "schedule": "day",
  "schedule_details": {
    "time": "01:30"
  },
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null
}

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, sslyze, nikto, skipfish)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

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: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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/"37b78459e1d8f61ebbe163d9a79b61f8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: a3764e23-8deb-4510-b7e2-57045e57fa04
X-Runtime: 0.033041
Content-Length: 370

Body

{
  "name": "portscan",
  "scan": {
    "id": 15,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2015-05-28T01:21:56.000+09:00",
    "updated_at": "2015-05-28T01:21:56.000+09:00"
  },
  "schedule": "month",
  "schedule_details": {
    "time": "01:30",
    "day": 8
  },
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null
}

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, sslyze, nikto, skipfish)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

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: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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/"213be77b773199ea45f4cb016d29efdd"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: c5150d85-9478-44e1-9e92-8753970903df
X-Runtime: 0.033186
Content-Length: 377

Body

{
  "name": "portscan",
  "scan": {
    "id": 14,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2015-05-28T01:21:56.000+09:00",
    "updated_at": "2015-05-28T01:21:56.000+09:00"
  },
  "schedule": "week",
  "schedule_details": {
    "time": "01:30",
    "day_of_week": 2
  },
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null
}

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, sslyze, nikto, skipfish)

Request

Route

GET /v1/targets/127.0.0.1/plugins

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"5a211ece6a1b8ff951755bc4de00306f"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 75309224-acb0-4a70-86ec-0ed725cf30d9
X-Runtime: 0.120847
Content-Length: 640

Body

[
  {
    "name": "portscan",
    "scan": {
      "id": 1,
      "benchmark": 1000,
      "ip": "127.0.0.1",
      "message": "",
      "status": "ok",
      "status_color": "green",
      "result_status": 200,
      "result_env": {
      },
      "created_at": "2015-05-28T01:21:54.000+09:00",
      "updated_at": "2015-05-28T01:21:54.000+09:00"
    },
    "schedule": "off",
    "schedule_details": null,
    "payment_option": "free_scan",
    "queued": false,
    "queued_at": null
  },
  {
    "name": "nikto",
    "scan": null,
    "schedule": "off",
    "schedule_details": null,
    "payment_option": "free_scan",
    "queued": true,
    "queued_at": "2015-05-28T01:21:54.000+09:00"
  },
  {
    "name": "skipfish",
    "scan": null,
    "schedule": "off",
    "schedule_details": null,
    "payment_option": "free_scan",
    "queued": false,
    "queued_at": null
  }
]

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, sslyze, nikto, skipfish)

Request

Route

GET /v1/targets/unknown_target/plugins

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/unknown_target/plugins" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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: d699ba24-672a-40ee-9873-74a5616db569
X-Runtime: 0.007533
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, sslyze, nikto, skipfish)

Request

Route

GET /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"e880e1ebfe199d104fa5882254b08f67"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: db7866b6-755b-4928-8cb7-cf27a0f61188
X-Runtime: 0.071692
Content-Length: 347

Body

{
  "name": "portscan",
  "scan": {
    "id": 3,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2015-05-28T01:21:55.000+09:00",
    "updated_at": "2015-05-28T01:21:55.000+09:00"
  },
  "schedule": "off",
  "schedule_details": null,
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null
}

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, sslyze, nikto, skipfish)

Request

Route

GET /v1/targets/unknown_target/plugins/portscan

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/unknown_target/plugins/portscan" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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: 09274084-8c81-4eb6-86b5-635f743d49b7
X-Runtime: 0.005493
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, sslyze, nikto, skipfish)

Request

Route

GET /v1/targets/127.0.0.1/plugins/unavailable_plugin

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/unavailable_plugin" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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: ff2ec493-649c-4d02-88a9-5148b3e95da9
X-Runtime: 0.013279
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, sslyze, nikto, skipfish)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

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: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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/"38d7087d663e08b30d64df0db55898bd"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: 65337a75-27af-4fe9-ba3f-1de2a26f27de
X-Runtime: 0.045920
Content-Length: 359

Body

{
  "name": "portscan",
  "scan": {
    "id": 7,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2015-05-28T01:21:55.000+09:00",
    "updated_at": "2015-05-28T01:21:55.000+09:00"
  },
  "schedule": "day",
  "schedule_details": {
    "time": "00:00"
  },
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null
}

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, sslyze, nikto, skipfish)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

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: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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/"f2ff169db04e5735323ee56bfee5438f"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: 2187d24d-ebc9-47da-9588-a60a2e9ddbff
X-Runtime: 0.035798
Content-Length: 369

Body

{
  "name": "portscan",
  "scan": {
    "id": 9,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2015-05-28T01:21:55.000+09:00",
    "updated_at": "2015-05-28T01:21:55.000+09:00"
  },
  "schedule": "month",
  "schedule_details": {
    "time": "00:00",
    "day": 1
  },
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null
}

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, sslyze, nikto, skipfish)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

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: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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/"aba711c636138b78ab1b4f0719d8e6a8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: e5f27b09-722c-4521-97ab-44654270b271
X-Runtime: 0.025697
Content-Length: 347

Body

{
  "name": "portscan",
  "scan": {
    "id": 6,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2015-05-28T01:21:55.000+09:00",
    "updated_at": "2015-05-28T01:21:55.000+09:00"
  },
  "schedule": "off",
  "schedule_details": null,
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null
}

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, sslyze, nikto, skipfish)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

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: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: 1d949a90-8962-4bfa-9d61-5f82e8a27f5a
X-Runtime: 0.015125
Content-Length: 77

Body

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, sslyze, nikto, skipfish)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/portscan

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

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: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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/"497b22cf444cf77218a4f47ec61258e3"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=PUT; path=/
X-Request-Id: 10d7ba89-f92c-4b57-b7cc-0a9f1e9a35ec
X-Runtime: 0.031050
Content-Length: 376

Body

{
  "name": "portscan",
  "scan": {
    "id": 8,
    "benchmark": 1000,
    "ip": "127.0.0.1",
    "message": "",
    "status": "ok",
    "status_color": "green",
    "result_status": 200,
    "result_env": {
    },
    "created_at": "2015-05-28T01:21:55.000+09:00",
    "updated_at": "2015-05-28T01:21:55.000+09:00"
  },
  "schedule": "week",
  "schedule_details": {
    "time": "00:00",
    "day_of_week": 0
  },
  "payment_option": "free_scan",
  "queued": false,
  "queued_at": null
}

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, sslyze, nikto, skipfish)

Request

Route

PUT /v1/targets/unknown_target/plugins/portscan

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/unknown_target/plugins/portscan" -d '' -X PUT \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: ca01e84b-1d22-4e63-b4cb-67b40a03922c
X-Runtime: 0.007194
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, sslyze, nikto, skipfish)

Request

Route

PUT /v1/targets/127.0.0.1/plugins/unavailable_plugin

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/unavailable_plugin" -d '' -X PUT \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: 43687a14-bd70-4b4a-a2fd-036996d5dfd3
X-Runtime: 0.013462
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, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

GET /v1/targets/127.0.0.1/scans

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/scans" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"42d022102fa30d41b8b830069d821172"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: d438905c-565f-4146-9a5d-911c19e07b8e
X-Runtime: 0.021301
Content-Length: 561

Body

[
  {
    "id": 19,
    "benchmark": 1000,
    "plugin": "sslyze",
    "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": "2015-05-28T01:21:56.000+09:00",
    "updated_at": "2015-05-28T01:21:56.000+09:00"
  },
  {
    "id": 18,
    "benchmark": 1000,
    "plugin": "portscan",
    "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": "2015-05-28T01:21:56.000+09:00",
    "updated_at": "2015-05-28T01:21:56.000+09:00"
  }
]

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, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

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

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"55520c46571d7a88c3471ac1fa20a333"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: d976426a-b7e8-4536-8cda-23a438c103ba
X-Runtime: 0.015726
Content-Length: 281

Body

[
  {
    "id": 20,
    "benchmark": 1000,
    "plugin": "portscan",
    "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": "2015-05-28T01:21:56.000+09:00",
    "updated_at": "2015-05-28T01:21:56.000+09:00"
  }
]

Listing scans

Endpoint

GET /v1/scans

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

GET /v1/scans

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/scans" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"e6f4c9415abc7ff8f5326853d86b8f62"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c6bba1f8-1070-46f0-9cef-c3ff6afe04ba
X-Runtime: 0.047572
Content-Length: 561

Body

[
  {
    "id": 17,
    "benchmark": 1000,
    "plugin": "sslyze",
    "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": "2015-05-28T01:21:56.000+09:00",
    "updated_at": "2015-05-28T01:21:56.000+09:00"
  },
  {
    "id": 16,
    "benchmark": 1000,
    "plugin": "portscan",
    "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": "2015-05-28T01:21:56.000+09:00",
    "updated_at": "2015-05-28T01:21:56.000+09:00"
  }
]

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, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

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

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans" -d '' -X POST \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: application/json; charset=utf-8
ETag: W/"e0aa021e21dddbd6d8cecec71e9cf564"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=POST; path=/
X-Request-Id: 8d3ce66c-67e6-486f-9f0d-9751b2b5488d
X-Runtime: 0.047096
Content-Length: 2

Body

OK

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, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

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

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

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: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: application/json; charset=utf-8
ETag: W/"e0aa021e21dddbd6d8cecec71e9cf564"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=POST; path=/
X-Request-Id: 38906414-b4da-4faf-ae96-a330fd81e71b
X-Runtime: 0.025638
Content-Length: 2

Body

OK

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, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

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

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/skipfish/scans" -d '' -X POST \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: 6eb0230b-1405-454e-b274-ea6e4d2bbf09
X-Runtime: 0.008122
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, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

GET /v1/scans/24

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/scans/24" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"8771637bc8090e8b810a162400c8b935"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 85f29aac-63ed-46d1-b436-d7f8b1198c9e
X-Runtime: 0.018532
Content-Length: 279

Body

{
  "id": 24,
  "benchmark": 1000,
  "plugin": "portscan",
  "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": "2015-05-28T01:21:57.000+09:00",
  "updated_at": "2015-05-28T01:21:57.000+09:00"
}

Show queued scan

Endpoint

GET /v1/scans/:scan_id

Parameters

Name Description
target_name Domain name or IP
plugin_name Plugin name (portscan, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

GET /v1/scans/23

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/scans/23" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"89e3d891de9922196ebd1c8bc3c1f9e1"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c632ecd1-4b4f-4817-ba00-567e2eaf4967
X-Runtime: 0.036122
Content-Length: 279

Body

{
  "id": 23,
  "benchmark": 1000,
  "plugin": "sslyze",
  "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": "2015-05-28T01:21:57.000+09:00",
  "updated_at": "2015-05-28T01:21:57.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, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

GET /v1/targets/127.0.0.1/scans/28

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/scans/28" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"873fbc2db13b83016881e2a9869827b3"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e0668c1a-d99f-4f86-a800-d00880a19bee
X-Runtime: 0.016926
Content-Length: 279

Body

{
  "id": 28,
  "benchmark": 1000,
  "plugin": "portscan",
  "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": "2015-05-28T01:21:57.000+09:00",
  "updated_at": "2015-05-28T01:21:57.000+09:00"
}

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, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

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

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans/30" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"e9e609283f920e4938ee9051706b6a61"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 800e20f8-6381-402c-bc85-a7977333b9b6
X-Runtime: 0.017152
Content-Length: 279

Body

{
  "id": 30,
  "benchmark": 1000,
  "plugin": "portscan",
  "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": "2015-05-28T01:21:57.000+09:00",
  "updated_at": "2015-05-28T01:21:57.000+09:00"
}

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, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

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

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans" -d '' -X POST \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: application/json; charset=utf-8
ETag: W/"e0aa021e21dddbd6d8cecec71e9cf564"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=POST; path=/
X-Request-Id: 710099bd-5eee-4a07-943e-ee9554bee4d5
X-Runtime: 0.027471
Content-Length: 2

Body

OK

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, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

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

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans" -d '' -X POST \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: 4176e7d0-2425-4824-a2a3-36e50747df7b
X-Runtime: 0.007315
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, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

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

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans" -d '' -X POST \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: 20fad7ef-e428-4ad0-8109-7cba1d2c773c
X-Runtime: 0.024733
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, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

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

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/plugins/portscan/scans" -d '' -X POST \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: application/json; charset=utf-8
ETag: W/"e0aa021e21dddbd6d8cecec71e9cf564"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=POST; path=/
X-Request-Id: 49869b0a-ba35-4fcf-80bf-4ebbceb15b33
X-Runtime: 0.039596
Content-Length: 2

Body

OK

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, sslyze, nikto, skipfish)
scan_id Scan UUID

Request

Route

GET /v1/scans/om6vKH3HEu9MxWmJIUYR8Q

Headers

Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/scans/om6vKH3HEu9MxWmJIUYR8Q" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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: 1ffbd285-b08a-4939-ab58-3bf514336f87
X-Runtime: 0.012801
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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

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: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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/"efd4811cf76e4c28b953526f1c4ce8f1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=POST; path=/
X-Request-Id: a8c726e6-f3d4-41b0-986c-ce5884afad8d
X-Runtime: 0.182693
Content-Length: 691

Body

{
  "status": "unchecked",
  "name": "github.com",
  "description": "Description",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=0e6ad8eaf74d448c83391ae8eaff8ad8",
  "ownership": "unknown",
  "plugins": [
    {
      "name": "portscan",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "nikto",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "skipfish",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    }
  ],
  "created_at": "2015-05-28T01:21:59.172+09:00",
  "updated_at": "2015-05-28T01:21:59.172+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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"fa29a8588183e33941e66b015f881feb"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c3972249-2ad8-48f4-861d-5174447c20e2
X-Runtime: 0.087492
Content-Length: 1601

Body

[
  {
    "status": "active",
    "name": "127.0.0.1",
    "description": "",
    "label": "",
    "ownership_url": "http://walti.dev/ownershipfiles?key=b1433fa7a957492b9a3ab6c4af0f0caf",
    "ownership": "confirmed",
    "plugins": [
      {
        "name": "portscan",
        "scan": {
          "id": 46,
          "benchmark": 1000,
          "ip": "127.0.0.1",
          "message": "",
          "status": "ok",
          "status_color": "green",
          "result_status": 200,
          "result_env": {
          },
          "created_at": "2015-05-28T01:21:58.000+09:00",
          "updated_at": "2015-05-28T01:21:58.000+09:00"
        },
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null
      },
      {
        "name": "nikto",
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": true,
        "queued_at": "2015-05-28T01:21:58.000+09:00"
      },
      {
        "name": "skipfish",
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null
      }
    ],
    "created_at": "2015-05-28T01:21:58.000+09:00",
    "updated_at": "2015-05-28T01:21:58.000+09:00"
  },
  {
    "status": "active",
    "name": "google.com",
    "description": "",
    "label": "",
    "ownership_url": "http://walti.dev/ownershipfiles?key=e40b2e4632ce44caaf56e2b4a654e0a3",
    "ownership": "confirmed",
    "plugins": [
      {
        "name": "portscan",
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null
      },
      {
        "name": "nikto",
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null
      },
      {
        "name": "skipfish",
        "scan": null,
        "schedule": "off",
        "schedule_details": null,
        "payment_option": "free_scan",
        "queued": false,
        "queued_at": null
      }
    ],
    "created_at": "2015-05-28T01:21:58.000+09:00",
    "updated_at": "2015-05-28T01:21:58.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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/non_existing" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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: 97154ebd-e295-4ea0-9be7-8d9ebd8bd99a
X-Runtime: 0.005067
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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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/"f1f7df82865885cf13fb2c91ec70e6fc"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: a81fc6ab-15b9-44ce-801d-fee725612620
X-Runtime: 0.059033
Content-Length: 919

Body

{
  "status": "active",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=a5b9dcbf3d8c4d969f5697f1aff7d49e",
  "ownership": "confirmed",
  "plugins": [
    {
      "name": "portscan",
      "scan": {
        "id": 47,
        "benchmark": 1000,
        "ip": "127.0.0.1",
        "message": "",
        "status": "ok",
        "status_color": "green",
        "result_status": 200,
        "result_env": {
        },
        "created_at": "2015-05-28T01:21:58.000+09:00",
        "updated_at": "2015-05-28T01:21:58.000+09:00"
      },
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "nikto",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": true,
      "queued_at": "2015-05-28T01:21:58.000+09:00"
    },
    {
      "name": "skipfish",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    }
  ],
  "created_at": "2015-05-28T01:21:58.000+09:00",
  "updated_at": "2015-05-28T01:21:58.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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -d '' -X POST \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: 1a83510c-c1b9-4f75-af9e-5d34a1361e4f
X-Runtime: 0.057439
Content-Length: 678

Body

{
  "status": "unchecked",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=cc2b1ff47d3a4220a68af02e39ea3326",
  "ownership": "queued",
  "plugins": [
    {
      "name": "portscan",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "nikto",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "skipfish",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    }
  ],
  "created_at": "2015-05-28T01:22:00.000+09:00",
  "updated_at": "2015-05-28T01:22:00.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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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: a3a9d870-55da-4249-b48b-de606e28e8db
X-Runtime: 0.037683
Content-Length: 679

Body

{
  "status": "unchecked",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=415cce006f9e4b3f873b027266623919",
  "ownership": "unknown",
  "plugins": [
    {
      "name": "portscan",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "nikto",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "skipfish",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    }
  ],
  "created_at": "2015-05-28T01:21:59.000+09:00",
  "updated_at": "2015-05-28T01:21:59.000+09:00"
}

Target activation succeeded

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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -d '' -X POST \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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/"1a0b7a771cfbcb7842246bcec192ee14"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=POST; path=/
X-Request-Id: 6a323862-7e26-47d4-844e-2e820084465e
X-Runtime: 0.036562
Content-Length: 756

Body

{
  "status": "active",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=13aed4a07f8d4d8bbce2a10dc381d3ae",
  "ownership": "confirmed",
  "plugins": [
    {
      "name": "portscan",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": true,
      "queued_at": "2015-05-28T01:22:01.000+09:00"
    },
    {
      "name": "nikto",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": true,
      "queued_at": "2015-05-28T01:22:01.000+09:00"
    },
    {
      "name": "skipfish",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": true,
      "queued_at": "2015-05-28T01:22:01.000+09:00"
    }
  ],
  "created_at": "2015-05-28T01:22:00.000+09:00",
  "updated_at": "2015-05-28T01:22:00.000+09:00"
}

Target activation succeeded

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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -d '' -X POST \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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/"1a0b7a771cfbcb7842246bcec192ee14"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=POST; path=/
X-Request-Id: 6a323862-7e26-47d4-844e-2e820084465e
X-Runtime: 0.036562
Content-Length: 756

Body

{
  "status": "active",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=13aed4a07f8d4d8bbce2a10dc381d3ae",
  "ownership": "confirmed",
  "plugins": [
    {
      "name": "portscan",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": true,
      "queued_at": "2015-05-28T01:22:01.000+09:00"
    },
    {
      "name": "nikto",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": true,
      "queued_at": "2015-05-28T01:22:01.000+09:00"
    },
    {
      "name": "skipfish",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": true,
      "queued_at": "2015-05-28T01:22:01.000+09:00"
    }
  ],
  "created_at": "2015-05-28T01:22:00.000+09:00",
  "updated_at": "2015-05-28T01:22:00.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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -d '' -X POST \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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/"e548e1f89e37681627950a19f7fca700"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=POST; path=/
X-Request-Id: 8ca3f005-39a9-41d6-973c-666cb9c15316
X-Runtime: 0.041275
Content-Length: 678

Body

{
  "status": "active",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=ab678c5d170844d2bdd34472fcddc598",
  "ownership": "confirmed",
  "plugins": [
    {
      "name": "portscan",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "nikto",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "skipfish",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    }
  ],
  "created_at": "2015-05-28T01:22:01.000+09:00",
  "updated_at": "2015-05-28T01:22:01.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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/non_existing/activate" -d '' -X POST \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: 2f33e300-f957-4473-a461-a2666c9ea035
X-Runtime: 0.009550
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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -d '' -X POST \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: f4b09d37-bd4a-455d-9376-1d4a7b7b8b21
X-Runtime: 0.048789
Content-Length: 678

Body

{
  "status": "unchecked",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=e51fb37937d3407d94acca7cb946f047",
  "ownership": "queued",
  "plugins": [
    {
      "name": "portscan",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "nikto",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "skipfish",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    }
  ],
  "created_at": "2015-05-28T01:22:00.000+09:00",
  "updated_at": "2015-05-28T01:22:00.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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

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: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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/"8a02d8f47a9899e07c3fe8d1fb4324f8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: request_method=POST; path=/
X-Request-Id: 6d55926f-4c68-4043-9d17-f967b4d55295
X-Runtime: 0.034409
Content-Length: 678

Body

{
  "status": "active",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=60e734c303064fccb7ca5d439ea500f7",
  "ownership": "confirmed",
  "plugins": [
    {
      "name": "portscan",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "nikto",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "skipfish",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    }
  ],
  "created_at": "2015-05-28T01:21:59.000+09:00",
  "updated_at": "2015-05-28T01:21:59.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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Body

target[name]=

Curl

curl "https://api.walti.io/v1/targets" -d 'target[name]=' -X POST \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA" \
	-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: 950c937c-9699-4c04-a3f8-a4f43c709763
X-Runtime: 0.018322
Content-Length: 19

Body

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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/non_existing/activate" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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: 6cf7c795-b731-4eeb-bb28-13ea8307f124
X-Runtime: 0.006855
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: nuMOnOh7r0nB3Nrv-_JhRQ
Api-Secret: fmRcQ3LqEupIFtus44EVbA

Curl

curl "https://api.walti.io/v1/targets/127.0.0.1/activate" -X GET \
	-H "Api-Key: nuMOnOh7r0nB3Nrv-_JhRQ" \
	-H "Api-Secret: fmRcQ3LqEupIFtus44EVbA"

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: dd682158-6943-4fea-9cca-ebc1fb74ef36
X-Runtime: 0.077966
Content-Length: 678

Body

{
  "status": "unchecked",
  "name": "127.0.0.1",
  "description": "",
  "label": "",
  "ownership_url": "http://walti.dev/ownershipfiles?key=6874764a1d724727861fb1557aba9028",
  "ownership": "queued",
  "plugins": [
    {
      "name": "portscan",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "nikto",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    },
    {
      "name": "skipfish",
      "scan": null,
      "schedule": "off",
      "schedule_details": null,
      "payment_option": "free_scan",
      "queued": false,
      "queued_at": null
    }
  ],
  "created_at": "2015-05-28T01:21:59.000+09:00",
  "updated_at": "2015-05-28T01:21:59.000+09:00"
}