Gomboc User Docs
  • Welcome
  • Getting Started
    • Access & Log in
    • Initial Set up
    • Free Trial Setup Guide
  • Integrations
    • Domains & IPs
    • Cloud Security Posture Management (CSPM)
      • Orca Security
      • Wiz
    • Source Code Management (SCM)
      • Azure Devops
      • GitHub
      • GitLab
      • BitBucket
    • VSCode Plugin
  • API
  • Configuration
    • Browser Settings
    • Authentication - Pwdless & SSO
    • User Management
  • Remediation Process
  • Security Status
  • Scan Results
  • Troubleshooting
  • Data Architecture & Flows
  • Glossary
Powered by GitBook
On this page
  • Creating API Credentials
  • GraphQL playground
  • Examples with curl
Edit on GitHub

API

PreviousVSCode PluginNextConfiguration

Last updated 1 month ago

Creating API Credentials

  1. Open your user account settings.

  2. Select "Personal Access Tokens"

  3. Create a personal access token, giving it a name and time to expiry.

  4. Copy the token to a safe place.

GraphQL playground

  1. Create a PAT from our Portal (top right corner your name > Settings > Personal Tokens)

  2. Go to to find our API playground

  3. In the Headers section (bottom center), add:

{
   "Authorization": "Bearer YOUR-TOKEN"
}
  1. Now you can fetch the schema (lower left corner, Refresh button)

  2. Next, use the left Explorer tool (top left corner, Folder button) to compose Queries or Mutations by selecting the fields that you care for

  3. Execute your query (top right corner, Play button)

Examples with curl

Get all the organization project names for the current user:

curl -X POST https://api.app.gomboc.ai/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR-TOKEN" \
  -d '{
    "query": "query MyQuery { organization { ... on Organization { name projects { name } } } }",
    "variables": {}
  }'

Link a repository to a project:

curl -X POST https://api.app.gomboc.ai/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR-TOKEN" \
  -d '{
    "query": "mutation MyMutation { linkRepositories(input: {projectId: \"\", providers: {gitProviderId: \"\", selectedRepositoryIds: \"\"}}) { ... on Link { id createdAt createdBy } ... on GombocError { code message } } }",
    "variables": {}
  }'

Something missing? Looking for a particular feature? Please get in touch

https://api.app.gomboc.ai