Simple Api description - m0sth8/bearded GitHub Wiki

Сейчас у нас три основных сущности в апи:

Target /api/v1/target/

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "totalCount": 1
    },
    "objects": [{
        "created": "2013-06-26T11:27:26.742342",
        "host": "bla.com",
        "id": 1,
        "modified": "2013-06-26T11:27:26.742844",
        "name": "bla",
        "resourceUri": "/api/v1/target/1/"
    }]
}

При создании обязательно нужно указывать host ( если name не указан, то host подставляется в name)

Tasks /api/v1/task/

Filters: (?field=value)

• target=target_id or target__in=target_id1,target_id2
• status or status__in

Ordering: (?order_by=field or -field)

• created, started, finished, lastActivity

Response example:

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "totalCount": 1
    },
    "objects": [{
        "created": "2013-06-26T11:27:26.742342",
        "target": "/api/v1/target/1/"
        "status": 1, /* 1 - created, 2 - working, 3 - waiting, 10 - completed, 11 - failed */
        "id": 1,
        "modified": "2013-06-26T11:27:26.742844",
        "resourceUri": "/api/v1/task/1/",
        "progress": 43, // 1-100,
        "started": "2013-06-26T11:27:26.742342" // or None if didn't start yet
        "finished": "2013-06-26T11:27:26.742342" // or None
        "lastActivity": "2013-06-26T11:27:26.742342",
        "name": "WpScan analyze"
        "info": "Analyzing plugins" # short information
    }]
}