CodeScan API
Manage your Hosted CodeScan Service
Developer tools#openapi#developer-tools
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Manage your Hosted CodeScan Service
Endpoints 2
- GETGet the status of a job
/job?jobId=stringFetches the status of a job - POSTQueues a job
/jobCreates a new job
API details
- Base URL
https://app.code-scan.com/api- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 2 operations on 1 pathGET 1POST 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
1.0.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the CodeScan API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the CodeScan API collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get the status of a job” (GET /job?jobId=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the CodeScan API?
Manage your Hosted CodeScan Service It is listed under Developer tools and has 2 endpoints.
Who publishes the CodeScan API?
It is listed from Code Scan's public API description (an OpenAPI document), not published by Code Scan on Swastik Codes. Anyone who controls code-scan.com can claim the profile by adding a DNS TXT record.
What is the base URL of the CodeScan API?
Requests go to https://app.code-scan.com/api. Endpoint paths are added to this base URL.
How do I authenticate with the CodeScan API?
With HTTP Basic authentication (username and password).
How many endpoints does the CodeScan API have?
2 operations on 1 path (1 GET, 1 POST).
Is forking the CodeScan API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.