Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Rest API documentation

See original GitHub issue

We use ctfd internally pretty heavily, and to this point we’ve been hand-jamming instances for every class, which works, but is time consuming. The Rest API is a great add, but the docs are lacking (e.g. /api/v1 API browser doesn’t have the params listed, etc.)

We’ve been internally ‘figuring out’ the various parameters of the Rest APIs internally and would like to assist in documenting this feature with examples (cURL) if the project is interested.

As an example, here is one of the first example scripts we wrote that demonstrates basic functionality:


## Initial setup.  Make admin user and write cookie for follow-on API calls
nonce=$(curl -s -c cookie | grep 'name="nonce"' | awk '{ print $4 }' | cut -d'"' -f2)
curl "" \
-H "Content-Type: application/x-www-form-urlencoded" \
-b cookie \
--data "nonce=$nonce&ctf_name=test&name=admin&email=test"%"40test&password=foobar&user_mode=users"

## Get current user
curl -X GET "" -H  "accept: application/json" -b cookie

## Make a new user
curl -X POST "" -H "content-type: application/json" -b cookie -d \

## make a new challenge
curl -X POST "" -H "content-type: application/json" -b cookie -d \
"description":"sample challenge"}'

## add a flag to a challnge
curl -X POST "" -H "content-type: application/json" -b cookie -d \

## Upload a file to a challenge.  You need to use a nonce from the admin page of the challenge you're editing.
nonce=$(curl -s -b cookie | grep nonce | cut -d'"' -f2)
curl -X POST "" -b cookie  \
-F "file=@some-local-file.png" \
-F "nonce=$nonce" \
-F "challenge=1" \
-F "type=challenge"

Our goal is to fully automate ctfd deployments and allow them to be dynamically generated by sourcing challenge definitions from version control (probably in yaml), and this is the first step in that process.

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Reactions:7
  • Comments:9 (7 by maintainers)

github_iconTop GitHub Comments

ColdHeatcommented, Jul 13, 2020

Swagger UI is now integrated into

ColdHeatcommented, Jul 13, 2020

I’m closing this since there is now an online interface to view the existing endpoints. Missing areas should be documented by the community over time.


Read more comments on GitHub >

github_iconTop Results From Across the Web

Rest API - GitHub Docs
To create integrations, retrieve data, and automate your workflows, build with the GitHub REST API.
Read more >
Swagger: API Documentation & Design Tools for Teams
Simplify API development for users, teams, and enterprises with our open source and professional toolset. Find out how Swagger can help you and...
Read more >
Google Docs API | Google Developers
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, ...
Read more >
Documenting APIs: A guide for technical writers and engineers
In your REST API documentation, you describe the various endpoints available, their methods, parameters, and other details, and you also document sample ...
Read more >
REST APIs - Atlassian Developer
The Jira Server platform provides the REST API for common features, like issues and workflows. To get started, read the reference documentation: Jira...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found