Skip to main content
POST
/
api
/
analysis
/
agents
/
scan
/
limit
Get Agent Scan Limit
curl --request POST \
  --url https://api.codeant.ai/api/analysis/agents/scan/limit \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization_id": "my-org",
  "service": "github"
}
'
{ "limit": 5, "scans_used": 2 }

Body

application/json
​
organization_id
string
required

Organization identifier on the VCS platform

Example:

"my-org"

​
service
enum<string>
required

Version control service provider

Available options:
github,
gitlab,
azuredevops,
bitbucket
Example:

"github"

​
github_base_url
string
default:https://github.com

Base URL for GitHub (for GitHub Enterprise Server)

​
gitlab_base_url
string
default:https://gitlab.com

Base URL for GitLab (for self-hosted instances)

​
azureDevopsBaseUrl
string
default:https://dev.azure.com

Base URL for Azure DevOps (for self-hosted instances)

​
bitbucket_base_url
string
default:https://api.bitbucket.org/2.0

Base URL for Bitbucket (for Bitbucket Data Center)

Response

Scan limit retrieved successfully

​
limit
integer

Maximum number of repositories that can be scanned

Example:

5

​
scans_used
integer

Number of unique repositories currently scanned

Example:

2

​
status
enum<string>

Only present when a new limit record was just created

Available options:
pending
Example:

"pending"