Community Edition API calls

ImpossibleWalrus · November 14, 2023, 8:23am

Goodmorning!
I’ve been fidgeting around with a project and it requires me to use the Dradis API, but all of the documentation that I can find is the PRO edition (even the ones on the CE documentation website haha)
As for a little context: I want to be able to upload attachments to projects.

So my question is, what is the right ‘url’ to use? IE: /pro/api/teams in the CURL.

etd · November 14, 2023, 1:36pm

Hi there,

Good news / bad news situation. The CE API is pretty similar to the Pro one, in CE you’re always working on /project/1. The docs for the resouces inside a project Nodes/Issues/Evidence/etc. should apply to both editions:

If you want to look under the hood, these are the actual CE API routes:

github.com

dradis/dradis-ce/blob/develop/engines/dradis-api/config/routes.rb

Dradis::CE::API::Engine::routes.draw do
  scope path: :api do
    defaults format: 'json' do
      scope module: :v1, constraints: Dradis::CE::API::RoutingConstraints.new(version: 1) do
        resources :issues
        resources :nodes do
          resources :evidence
          resources :notes
          constraints(filename: /.*/) do
            resources :attachments, param: :filename
          end
        end
      end

      scope module: :v3, constraints: Dradis::CE::API::RoutingConstraints.new(version: 3, default: true) do
        resources :boards do
          resources :lists do
            resources :cards do
            end
          end

This file has been truncated. show original

As for the bad news, there isn’t a way to send an attachment binary/blob through the API just yet.

Can you describe the use case? Would you be able to send it over SSH? Then we can process it from there. If you tell us what you’re needing, perhaps there’s a way to get it done!

ImpossibleWalrus · November 15, 2023, 10:59am

Thank you so much for the reaction!
The git definitely helps me understand a bit better where my attempts went wrong and also reassures me that at least some of my ideas are possible.

As for the use case, I currently have a script that scrapes information from a web application. The idea was to send this information as evidence to Dradis along with a png attachment. The information and files are ready, just the connection part is left. SSH is definitely available!

Topic		Replies	Views
Dradis HTTP API Community Edition	5	3614	April 21, 2014
Creating a Project - CE Edition Community Edition	1	2321	July 6, 2017
How to search the content in the whole project Community Edition	3	2104	June 30, 2016
How to add a project template when creating a Dradis project using the Dradis HTTP API Community Edition	2	1721	February 2, 2018
Availability of Qualys Plugin for Dradis Community Edition	2	1556	October 13, 2014

Community Edition API calls

Related Topics