Methodologies endpoint

Methodologies belong to a Project

When working with data for a specific Project like Boards or Nodes, make sure to define the Dradis-Project-Id HTTP header like so:

curl \
  -H 'Authorization: Token token="xMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  https://dradis-pro.dev/pro/api/boards

GET /pro/api/boards

Retrieves all the Methodology boards in your specific project, ordered by the created_at timestamp.

You can paginate the results for 25 views per page by appending e.g. \?page\=1 and \?page\=2, so e.g. http://dradis-pro.dev/pro/api/boards\?page\=1.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  http://dradis-pro.dev/pro/api/boards

Result:

[
  {
    "id": 23,
    "name": "My Second Methodology",
    "node_id": 912,
    "created_at": "2023-08-30T18:05:03.000Z",
    "updated_at": "2023-08-30T18:05:03.000Z",
    "lists": [
      {
        "id": 55,
        "name": "To Do",
        "created_at": "2023-08-30T18:05:03.000Z",
        "updated_at": "2023-08-30T18:05:03.000Z",
        "cards": [

        ]
      },
      {
        "id": 56,
        "name": "In Progress",
        "created_at": "2023-08-30T18:05:03.000Z",
        "updated_at": "2023-08-30T18:05:03.000Z",
        "cards": [

        ]
      },
      {
        "id": 57,
        "name": "Done",
        "created_at": "2023-08-30T18:05:03.000Z",
        "updated_at": "2023-08-30T18:05:03.000Z",
        "cards": [

        ]
      }
    ]
  },
  {
    "id": 22,
    "name": "My Sample Methodology",
    "node_id": 912,
    "created_at": "2023-08-30T18:00:58.000Z",
    "updated_at": "2023-08-30T18:03:15.000Z",
    "lists": [
      {
        "id": 52,
        "name": "To Do",
        "created_at": "2023-08-30T18:00:58.000Z",
        "updated_at": "2023-08-30T18:02:40.000Z",
        "cards": [
          {
            "id": 786,
            "description": "#[Details]#\r\nMy details go here!\r\n\r\n#[Results]#\r\nTester comments here.",
            "due_date": "2023-09-07",
            "name": "My first task",
            "fields": {
              "List": "To_Do",
              "Title": "My first task",
              "Details": "My details go here!",
              "Results": "Tester comments here."
            },
            "assignees": [
              {
                "id": 1,
                "email": "christoffer@example.com"
              }
            ]
          }
        ]
      },
      {
        "id": 53,
        "name": "In Progress",
        "created_at": "2023-08-30T18:00:58.000Z",
        "updated_at": "2023-08-30T18:03:15.000Z",
        "cards": [
          {
            "id": 787,
            "description": "#[Details]#\r\nMore details here!\r\n\r\n#[Results]#\r\nTester comments here.",
            "due_date": "2023-09-08",
            "name": "My second task",
            "fields": {
              "List": "In_Progress",
              "Title": "My second task",
              "Details": "More details here!",
              "Results": "Tester comments here."
            },
            "assignees": [
              {
                "id": 1,
                "email": "christoffer@example.com"
              }
            ]
          }
        ]
      },
      {
        "id": 54,
        "name": "Done",
        "created_at": "2023-08-30T18:00:58.000Z",
        "updated_at": "2023-08-30T18:00:58.000Z",
        "cards": [

        ]
      }
    ]
  }
]

GET /pro/api/boards/:board_id/lists

Retrieves all the lists from a given board in your specific project, ordered by the created_at timestamp.

You can paginate the results for 25 views per page by appending e.g. \?page\=1 and \?page\=2, so e.g. http://dradis-pro.dev/pro/api/boards\?page\=1.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  http://dradis-pro.dev/pro/api/boards/22/lists

Result:

[
  {
    "id": 53,
    "name": "In Progress",
    "created_at": "2023-08-30T18:00:58.000Z",
    "updated_at": "2023-08-30T18:03:15.000Z",
    "cards": [
      {
        "id": 787,
        "description": "#[Details]#\r\nMore details here!\r\n\r\n#[Results]#\r\nTester comments here.",
        "due_date": "2023-09-08",
        "name": "My second task",
        "fields": {
          "List": "In_Progress",
          "Title": "My second task",
          "Details": "More details here!",
          "Results": "Tester comments here."
        },
        "assignees": [
          {
            "id": 1,
            "email": "christoffer@example.com"
          }
        ]
      }
    ]
  },
  {
    "id": 52,
    "name": "To Do",
    "created_at": "2023-08-30T18:00:58.000Z",
    "updated_at": "2023-08-30T18:02:40.000Z",
    "cards": [
      {
        "id": 786,
        "description": "#[Details]#\r\nMy details go here!\r\n\r\n#[Results]#\r\nTester comments here.",
        "due_date": "2023-09-07",
        "name": "My first task",
        "fields": {
          "List": "To_Do",
          "Title": "My first task",
          "Details": "My details go here!",
          "Results": "Tester comments here."
        },
        "assignees": [
          {
            "id": 1,
            "email": "christoffer@example.com"
          }
        ]
      }
    ]
  },
  {
    "id": 54,
    "name": "Done",
    "created_at": "2023-08-30T18:00:58.000Z",
    "updated_at": "2023-08-30T18:00:58.000Z",
    "cards": [

    ]
  }
]

GET /pro/api/boards/:board_id/lists/:list_id/cards

Retrieves all the cards from a given list in a given board in your specific project, ordered by the created_at timestamp.

You can paginate the results for 25 views per page by appending e.g. \?page\=1 and \?page\=2, so e.g. http://dradis-pro.dev/pro/api/boards\?page\=1.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  http://dradis-pro.dev/pro/api/boards/22/lists/52/cards

Result:

[
  {
    "id": 787,
    "description": "#[Details]#\r\nMore details here!\r\n\r\n#[Results]#\r\nTester comments here.",
    "due_date": "2023-09-08",
    "name": "My second task",
    "fields": {
      "List": "To_Do",
      "Title": "My second task",
      "Details": "More details here!",
      "Results": "Tester comments here."
    },
    "assignees": [
      {
        "id": 1,
        "email": "christoffer@example.com"
      }
    ]
  },
  {
    "id": 786,
    "description": "#[Details]#\r\nMy details go here!\r\n\r\n#[Results]#\r\nTester comments here.",
    "due_date": "2023-09-07",
    "name": "My first task",
    "fields": {
      "List": "To_Do",
      "Title": "My first task",
      "Details": "My details go here!",
      "Results": "Tester comments here."
    },
    "assignees": [
      {
        "id": 1,
        "email": "christoffer@example.com"
      }
    ]
  }
]

GET /pro/api/boards/:id

Retrieves a single Board from your specified project.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  http://dradis-pro.dev/pro/api/boards/22

Result:

{
  "id": 22,
  "name": "My Sample Methodology",
  "node_id": 912,
  "created_at": "2023-08-30T18:00:58.000Z",
  "updated_at": "2023-08-30T18:08:50.000Z",
  "lists": [
    {
      "id": 52,
      "name": "To Do",
      "created_at": "2023-08-30T18:00:58.000Z",
      "updated_at": "2023-08-30T18:08:50.000Z",
      "cards": [
        {
          "id": 786,
          "description": "#[Details]#\r\nMy details go here!\r\n\r\n#[Results]#\r\nTester comments here.",
          "due_date": "2023-09-07",
          "name": "My first task",
          "fields": {
            "List": "To_Do",
            "Title": "My first task",
            "Details": "My details go here!",
            "Results": "Tester comments here."
          },
          "assignees": [
            {
              "id": 1,
              "email": "christoffer@example.com"
            }
          ]
        }
      ]
    },
    {
      "id": 53,
      "name": "In Progress",
      "created_at": "2023-08-30T18:00:58.000Z",
      "updated_at": "2023-08-30T18:08:50.000Z",
      "cards": [
        {
          "id": 787,
          "description": "#[Details]#\r\nMore details here!\r\n\r\n#[Results]#\r\nTester comments here.",
          "due_date": "2023-09-08",
          "name": "My second task",
          "fields": {
            "List": "In_Progress",
            "Title": "My second task",
            "Details": "More details here!",
            "Results": "Tester comments here."
          },
          "assignees": [
            {
              "id": 1,
              "email": "christoffer@example.com"
            }
          ]
        }
      ]
    },
    {
      "id": 54,
      "name": "Done",
      "created_at": "2023-08-30T18:00:58.000Z",
      "updated_at": "2023-08-30T18:00:58.000Z",
      "cards": [

      ]
    }
  ]
}

GET /pro/api/boards/:board_id/lists/:list_id

Retrieves a single list from a given board from your specified project.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  http://dradis-pro.dev/pro/api/boards/22/lists/52

Result:

{
  "id": 52,
  "name": "To Do",
  "created_at": "2023-08-30T18:00:58.000Z",
  "updated_at": "2023-08-30T18:08:50.000Z",
  "cards": [
    {
      "id": 786,
      "description": "#[Details]#\r\nMy details go here!\r\n\r\n#[Results]#\r\nTester comments here.",
      "due_date": "2023-09-07",
      "name": "My first task",
      "fields": {
        "List": "To_Do",
        "Title": "My first task",
        "Details": "My details go here!",
        "Results": "Tester comments here."
      },
      "assignees": [
        {
          "id": 1,
          "email": "christoffer@example.com"
        }
      ]
    }
  ]
}

GET /pro/api/boards/:board_id/lists/:list_id/cards/:card_id

Retrieves a single card from a given list from a given board from your specified project.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  http://dradis-pro.dev/pro/api/boards/22/lists/52/cards/786

Result:

{
  "id": 786,
  "description": "#[Details]#\r\nMy details go here!\r\n\r\n#[Results]#\r\nTester comments here.",
  "due_date": "2023-09-07",
  "name": "My first task",
  "fields": {
    "List": "To_Do",
    "Title": "My first task",
    "Details": "My details go here!",
    "Results": "Tester comments here."
  },
  "assignees": [
    {
      "id": 1,
      "email": "christoffer@example.com"
    }
  ]
}

POST /pro/api/boards

Creates a Board in the specified project. The attributes for the Board must be provided in the POST body as JSON.

HTTP status 201 will be returned if the creation completes successfully, and a Location header will be sent with the response, set to the URL of the newly created resource.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  -H 'Content-type: application/json' \
  -X POST \
  -d '{"name": "newboard1"}' \
  http://dradis-pro.dev/pro/api/boards

Result:

{
  "id": 24,
  "name": "newboard1",
  "node_id": 912,
  "created_at": "2023-08-30T18:15:18.000Z",
  "updated_at": "2023-08-30T18:15:18.000Z",
  "lists": [

  ]
}

POST /pro/api/boards/:board_id/lists

Creates a list on a given board in the specified project. The attributes for the Board must be provided in the POST body as JSON.

HTTP status 201 will be returned if the creation completes successfully, and a Location header will be sent with the response, set to the URL of the newly created resource.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  -H 'Content-type: application/json' \
  -X POST \
  -d '{"name": "newlist1"}' \
  http://dradis-pro.dev/pro/api/boards/22/lists

Result:

{
  "id": 58,
  "name": "newlist1",
  "created_at": "2023-08-30T18:18:01.000Z",
  "updated_at": "2023-08-30T18:18:01.000Z",
  "cards": [

  ]
}

POST /pro/api/boards/:board_id/lists/:list_id/cards

Creates a card on a given list on a given board in the specified project. The attributes for the Board must be provided in the POST body as JSON.

HTTP status 201 will be returned if the creation completes successfully, and a Location header will be sent with the response, set to the URL of the newly created resource.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  -H 'Content-type: application/json' \
  -X POST \
  -d '{"name": "newcard1", "description": "description field"}' \
  http://dradis-pro.dev/pro/api/boards/22/lists/52/cards

Result:

{
  "id": 788,
  "description": "description field",
  "due_date": null,
  "name": "newcard1",
  "fields": {
    "List": "To_Do",
    "Title": "newcard1"
  },
  "assignees": [

  ]
}

PUT /pro/api/boards/:board_id

Updates a Board in the specified project. The attributes to be updated must be provided in the body as JSON. Like the POST method, make sure to write out the new content of the Board using JSON on one line subbing in \r\n to create newlines as needed.

HTTP status 200 will be returned if the update completes successfully.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  -H 'Content-type: application/json' \
  -X PUT \
  -d '{"name": "newname"}' \
  http://dradis-pro.dev/pro/api/boards/24

Result:

{
  "id": 24,
  "name": "newname",
  "node_id": 912,
  "created_at": "2023-08-30T18:15:18.000Z",
  "updated_at": "2023-08-30T18:22:01.000Z",
  "lists": [

  ]
}

PUT /pro/api/boards/:board_id/lists/:list_id

Updates a list on a given board in the specified project. The attributes to be updated must be provided in the body as JSON. Like the POST method, make sure to write out the new content of the Board using JSON on one line subbing in \r\n to create newlines as needed.

HTTP status 200 will be returned if the update completes successfully.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  -H 'Content-type: application/json' \
  -X PUT \
  -d '{"name": "newname"}' \
  http://dradis-pro.dev/pro/api/boards/22/lists/58

Result:

{
  "id": 58,
  "name": "newname",
  "created_at": "2023-08-30T18:18:01.000Z",
  "updated_at": "2023-08-30T18:24:19.000Z",
  "cards": [

  ]
}

PUT /pro/api/boards/:board_id/lists/:list_id/cards/:card_id

Updates a card on a given list on a given board in the specified project. The attributes to be updated must be provided in the body as JSON. Like the POST method, make sure to write out the new content of the Board using JSON on one line subbing in \r\n to create newlines as needed.

HTTP status 200 will be returned if the update completes successfully.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  -H 'Content-type: application/json' \
  -X PUT \
  -d '{"name": "newcard1", "description": "updated description field"}' \
  http://dradis-pro.dev/pro/api/boards/22/lists/52/cards/788

Result:

{
  "id": 788,
  "description": "updated description field",
  "due_date": null,
  "name": "newcard1",
  "fields": {
    "List": "To_Do",
    "Title": "newcard1"
  },
  "assignees": [

  ]
}

PUT /pro/api/boards/:board_id/lists/:list_id/position

Available from Dradis 5.5.0. Reorders a list within its board. This endpoint also accepts PATCH. Scoped personal access tokens need lists:update permission.

Send prev_id and next_id as top-level JSON parameters. They identify the lists immediately before and after the destination position. Both must belong to the board and be adjacent before the move. Neither may be the list being moved.

  • Move to the beginning: send only next_id, identifying the current first list.
  • Move to the end: send only prev_id, identifying the current last list.
  • Move between two lists: send both IDs, for example {"prev_id": 52, "next_id": 53}.

Sample request, moving list 54 before list 52:

curl \
  -H 'Authorization: Bearer <your-personal-access-token>' \
  -H 'Dradis-Project-Id: 3' \
  -H 'Content-Type: application/json' \
  -X PUT \
  -d '{"next_id": 52}' \
  https://dradis-pro.dev/pro/api/boards/22/lists/54/position

A successful move returns 200 OK with the list's attributes and cards, plus previous_id. In this example, previous_id is null because list 54 is now first. A list outside the URL's board returns 404 Not Found. Invalid neighbors return 422 with validation details in errors.

PUT /pro/api/boards/:board_id/lists/:list_id/cards/:card_id/position

Available from Dradis 5.5.0. Moves a card within its list or to another list on the same board. This endpoint also accepts PATCH. Scoped personal access tokens need cards:update permission. The URL must identify the card's current list.

Send these parameters at the top level of the JSON body:

Parameter Use
new_list_id The destination list on the same board. Omit it to reorder the card within its current list.
prev_id, next_id Cards immediately before and after the destination position. Use the same neighbor rules as list positioning, with card IDs from the destination list.

Sending only new_list_id appends the card to that list, or makes it the first card if the list is empty. If it identifies the card's current list, the request returns 200 OK without changing its position or creating a move activity.

Sample request, moving card 786 from list 52 to the end of list 53:

curl \
  -H 'Authorization: Bearer <your-personal-access-token>' \
  -H 'Dradis-Project-Id: 3' \
  -H 'Content-Type: application/json' \
  -X PUT \
  -d '{"new_list_id": 53}' \
  https://dradis-pro.dev/pro/api/boards/22/lists/52/cards/786/position

To choose a position in the destination list, include its neighboring card IDs, for example {"new_list_id": 53, "prev_id": 787, "next_id": 789}. To move to the beginning of that list, send {"new_list_id": 53, "next_id": 787}, where card 787 is currently first.

A successful move returns 200 OK with the card's attributes, plus list_id and previous_id. Subsequent requests must use the returned list_id in the URL. A missing destination or a destination on another board returns 404 Not Found. Invalid neighbors return 422 with validation details in errors.

DELETE /pro/api/boards/:id

Deletes a board from your specified project. HTTP status 200 will be returned if the deletion completes successfully.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  -H 'Content-type: application/json' \
  -X DELETE \
  http://dradis-pro.dev/pro/api/boards/22

Result:

{
  "message": "Resource deleted successfully"
}

DELETE /pro/api/boards/:board_id/lists/:list_id

Deletes a list from a given board from your specified project. HTTP status 200 will be returned if the deletion completes successfully.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  -H 'Content-type: application/json' \
  -X DELETE \
  http://dradis-pro.dev/pro/api/boards/22/lists/52

Result:

{
  "message": "Resource deleted successfully"
}

DELETE /pro/api/boards/:board_id/lists/:list_id/cards/:card_id

Deletes a card from a given list from a given board from your specified project. HTTP status 200 will be returned if the deletion completes successfully.

Sample request:

curl \
  -H 'Authorization: Token token="hxMsNwttqN5bVNEYcrIF01s65"' \
  -H 'Dradis-Project-Id: 3' \
  -H 'Content-type: application/json' \
  -X DELETE \
  http://dradis-pro.dev/pro/api/boards/22/lists/52/cards/786

Result:

{
  "message": "Resource deleted successfully"
}

Next help article: Issue Library endpoint →

Seven Strategies To Differentiate Your Cybersecurity Consultancy

You don't need to reinvent the wheel to stand out from other cybersecurity consultancies. Often, it's about doing the simple things better, and clearly communicating what sets you apart.

  • Tell your story better
  • Improve your testimonials and case studies
  • Build strategic partnerships

Loading form...

Your email is kept private. We don't do the spam thing.