LogoLogo
Book a Demo
  • Introduction
  • Getting Started
    • Install
    • Configuration - General
    • Configuration - Code
    • Configuration - Dependencies
    • Configuration - Containers
    • Configuration - Secrets
    • Configuration - Attack Surface Monitoring
  • Features
    • Code Scanning
      • Custom Rules
      • Supported Languages
    • Dependency Scanning
      • Supported Package Managers
    • Secrets Scanning
      • Supported Secret Types
      • Confidential Information
    • Web App Penetration Testing
      • Quickstart
      • Supported Applications
      • Apps in Private Networks
      • Custom Rules
    • Orchestration
  • Integrations
    • GitHub
      • Repository Issue Dashboards
    • Bitbucket
      • Repository Dashboards
    • Slack
      • Install
    • Jira
      • Install
      • Configuration
      • Assignee
      • Priorities
      • Manual Ticket Creation
    • AWS
      • Prerequisites
      • Configuration
  • API Reference
    • Nullify API
      • Authentication
      • Pagination
      • Admin
      • Code Scanning (SAST)
      • Dependency Scanning (SCA)
      • Secrets Scanning
      • Dynamic Scanning (DAST)
  • Enterprise Tier
    • GitHub Install
    • Azure DevOps Install
  • More Info
    • About Us
    • Latest Updates
    • Security
    • Data Handling Policy
Powered by GitBook

© 2023 Nullify | All Rights Reserved.

On this page

Was this helpful?

  1. API Reference
  2. Nullify API

Admin

General admin API endpoints for Nullify.

PreviousPaginationNextCode Scanning (SAST)

Last updated 1 month ago

Was this helpful?

Introduction

The admin API endpoints provide a RESTful interface for querying data about repositories, teams, and more.

Base URL

All API endpoints are accessed through the base URL: https://api.<YOUR-TENANT-NAME>.nullify.ai

Replace <YOUR-TENANT-NAME> with your organization's tenant name. For example, if your tenant name is "acme", the base URL would be https://api.acme.nullify.ai.

Get Repositories

curl -L \
   -H "Accept: application/json" \
   -H "Authorization: Bearer <YOUR-TOKEN>" \
   https://api.<YOUR-TENANT-NAME>.nullify.ai/admin/repositories?githubOwnerId=1234

Get Teams

This endpoint only works for GitHub organisations currently.

curl -L \
   -H "Accept: application/json" \
   -H "Authorization: Bearer <YOUR-TOKEN>" \
   https://api.<YOUR-TENANT-NAME>.nullify.ai/admin/teams?githubOwnerId=1234

Get Repositories

get

Get a list of repositories in the org

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

githubOwnerIdintegerOptional

The Github owner ID

gitlabGroupIdintegerOptional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional
githubRepositoryIdinteger[]Optional
githubTeamIdintegerOptional
Responses
200
OK
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /admin/repositories HTTP/1.1
Host: api.<YOUR-TENANT>.nullify.com
Accept: */*
{
  "repositories": [
    {
      "cloneURL": "text",
      "defaultBranch": "text",
      "fullName": "text",
      "hasIssues": true,
      "head": "text",
      "id": "text",
      "isArchived": true,
      "isGlobalConfig": true,
      "isInitialized": true,
      "isPublic": true,
      "name": "text",
      "ownerProvider": {
        "azure": {
          "baseUrl": "text",
          "organizationId": "text",
          "organizationName": "text",
          "tenantId": "text"
        },
        "bitbucket": {
          "appKey": "text",
          "baseUrl": "text",
          "clientKey": "text",
          "ownerId": "text",
          "ownerName": "text",
          "sharedSecret": "text"
        },
        "external": {
          "installationId": "text"
        },
        "github": {
          "installationId": 1,
          "owner": "text",
          "ownerId": 1,
          "ownerType": "text"
        },
        "gitlab": {
          "baseUrl": "text",
          "groupId": 1,
          "groupName": "text"
        },
        "id": "text",
        "jira": {
          "appKeyId": "text",
          "baseUrl": "text",
          "installationId": "text",
          "ownerId": "text",
          "sharedSecret": "text"
        },
        "slack": {}
      },
      "provider": {
        "azure": {
          "projectId": "text",
          "projectName": "text",
          "repositoryId": "text",
          "repositoryName": "text"
        },
        "bitbucket": {
          "projectKey": "text",
          "projectName": "text",
          "repositoryId": "text",
          "repositoryName": "text"
        },
        "github": {
          "hasIssue": true,
          "owner": "text",
          "ownerId": 1,
          "repositoryId": 1,
          "repositoryName": "text"
        },
        "gitlab": {
          "projectId": 1,
          "projectName": "text"
        },
        "id": "text"
      },
      "repoSizeGiB": 1
    }
  ]
}
  • Introduction
  • Base URL
  • Get Repositories
  • GETGet Repositories
  • Get Teams