Services

Get Service Terms

get
Authorizations
Responses
200
Successful Response
application/json
get
GET /api/services/_terms HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "terms": [
    {
      "name": "text",
      "type": "Int",
      "terms": [
        {
          "lowerBound": 1,
          "upperBound": 1,
          "count": 1
        }
      ]
    }
  ]
}

List Services

get
Authorizations
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
itemsany ofOptional
or
or
Responses
200
Successful Response
application/json
get
GET /api/services HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]
{
  "items": [
    {
      "id": 1,
      "name": "text",
      "heeler_id": "text",
      "repository": "text",
      "status": "text",
      "application_path": "text",
      "param": "text",
      "source_type": "text",
      "source": {
        "id": 1,
        "owner": {
          "id": 1,
          "login": "text",
          "url": "text",
          "html_url": "text",
          "avatars_url": "text"
        },
        "name": "text",
        "full_name": "text",
        "org": "text",
        "description": "text",
        "default_branch": "text",
        "master_branch": "text",
        "created_at": "text",
        "updated_at": "text",
        "git_url": "text",
        "ssh_url": "text",
        "html_url": "text",
        "language": "text",
        "fork": true,
        "open_issues_count": 1,
        "size": 1,
        "archived": true,
        "disabled": true,
        "private": true,
        "git_commits_url": "text",
        "branch_count": 0,
        "githubContributors": [
          {
            "login": "text",
            "name": "text",
            "avatar_url": "text",
            "contributions": 1,
            "url": "text"
          }
        ],
        "heeler_id": "text"
      },
      "severity": "text",
      "tier": "TIER_4",
      "critical_findings_count": 1,
      "high_findings_count": 1,
      "medium_findings_count": 1,
      "low_findings_count": 1,
      "info_findings_count": 1,
      "findings_count": 1,
      "num_deployments": 1,
      "cloud_types": [],
      "accounts": [],
      "tech_leads": [
        {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        }
      ],
      "suggested_tech_leads": [
        {
          "identity": {
            "id": 1,
            "name": "text",
            "email": "text",
            "alternate_emails": [
              "text"
            ],
            "is_hidden": true
          },
          "lines_of_code": 1,
          "last_commit_time": "2025-07-18T20:15:15.062Z"
        }
      ],
      "security_leads": [
        {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        }
      ],
      "latest_deployment_heeler_id": "text",
      "latest_deployed_time": "text",
      "latest_cset": "text",
      "latest_tags": [],
      "applications": [
        {
          "id": 1,
          "name": "text",
          "description": "text",
          "service_count": 0,
          "resource_count": 0,
          "business_impact": "HIGH",
          "tier": "TIER_1",
          "application_type": "static",
          "tech_leads": [
            {
              "id": 1,
              "name": "text",
              "email": "text",
              "alternate_emails": [
                "text"
              ],
              "is_hidden": true
            }
          ],
          "security_leads": [
            {
              "id": 1,
              "name": "text",
              "email": "text",
              "alternate_emails": [
                "text"
              ],
              "is_hidden": true
            }
          ],
          "severity": "LOW",
          "created": "2025-07-18T20:15:15.062Z",
          "updated": "2025-07-18T20:15:15.062Z",
          "meta": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "services": [
            1
          ],
          "urgent": 0,
          "plan": 0,
          "defer": 0
        }
      ],
      "annotations": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "created": "text",
      "updated": "text",
      "description": "text",
      "project": {
        "project_id": "text",
        "name": "text",
        "key": "text",
        "source": "text",
        "connection_id": 1
      },
      "team": {
        "team_id": "text",
        "name": "text",
        "source": "text"
      },
      "project_ticket_type": {
        "ticket_type_id": "text",
        "name": "text",
        "image_url": "text"
      },
      "channel": {
        "name": "text",
        "source": "text",
        "connection_id": 1,
        "channel_id": "text"
      },
      "urgent": 0,
      "plan": 0,
      "defer": 0
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

List Services

post
Authorizations
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
itemsany ofOptional
or
or
Responses
200
Successful Response
application/json
post
POST /api/services HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]
{
  "items": [
    {
      "id": 1,
      "name": "text",
      "heeler_id": "text",
      "repository": "text",
      "status": "text",
      "application_path": "text",
      "param": "text",
      "source_type": "text",
      "source": {
        "id": 1,
        "owner": {
          "id": 1,
          "login": "text",
          "url": "text",
          "html_url": "text",
          "avatars_url": "text"
        },
        "name": "text",
        "full_name": "text",
        "org": "text",
        "description": "text",
        "default_branch": "text",
        "master_branch": "text",
        "created_at": "text",
        "updated_at": "text",
        "git_url": "text",
        "ssh_url": "text",
        "html_url": "text",
        "language": "text",
        "fork": true,
        "open_issues_count": 1,
        "size": 1,
        "archived": true,
        "disabled": true,
        "private": true,
        "git_commits_url": "text",
        "branch_count": 0,
        "githubContributors": [
          {
            "login": "text",
            "name": "text",
            "avatar_url": "text",
            "contributions": 1,
            "url": "text"
          }
        ],
        "heeler_id": "text"
      },
      "severity": "text",
      "tier": "TIER_4",
      "critical_findings_count": 1,
      "high_findings_count": 1,
      "medium_findings_count": 1,
      "low_findings_count": 1,
      "info_findings_count": 1,
      "findings_count": 1,
      "num_deployments": 1,
      "cloud_types": [],
      "accounts": [],
      "tech_leads": [
        {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        }
      ],
      "suggested_tech_leads": [
        {
          "identity": {
            "id": 1,
            "name": "text",
            "email": "text",
            "alternate_emails": [
              "text"
            ],
            "is_hidden": true
          },
          "lines_of_code": 1,
          "last_commit_time": "2025-07-18T20:15:15.062Z"
        }
      ],
      "security_leads": [
        {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        }
      ],
      "latest_deployment_heeler_id": "text",
      "latest_deployed_time": "text",
      "latest_cset": "text",
      "latest_tags": [],
      "applications": [
        {
          "id": 1,
          "name": "text",
          "description": "text",
          "service_count": 0,
          "resource_count": 0,
          "business_impact": "HIGH",
          "tier": "TIER_1",
          "application_type": "static",
          "tech_leads": [
            {
              "id": 1,
              "name": "text",
              "email": "text",
              "alternate_emails": [
                "text"
              ],
              "is_hidden": true
            }
          ],
          "security_leads": [
            {
              "id": 1,
              "name": "text",
              "email": "text",
              "alternate_emails": [
                "text"
              ],
              "is_hidden": true
            }
          ],
          "severity": "LOW",
          "created": "2025-07-18T20:15:15.062Z",
          "updated": "2025-07-18T20:15:15.062Z",
          "meta": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "services": [
            1
          ],
          "urgent": 0,
          "plan": 0,
          "defer": 0
        }
      ],
      "annotations": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "created": "text",
      "updated": "text",
      "description": "text",
      "project": {
        "project_id": "text",
        "name": "text",
        "key": "text",
        "source": "text",
        "connection_id": 1
      },
      "team": {
        "team_id": "text",
        "name": "text",
        "source": "text"
      },
      "project_ticket_type": {
        "ticket_type_id": "text",
        "name": "text",
        "image_url": "text"
      },
      "channel": {
        "name": "text",
        "source": "text",
        "connection_id": 1,
        "channel_id": "text"
      },
      "urgent": 0,
      "plan": 0,
      "defer": 0
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Service Sbom

get
Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
get
GET /api/services/{service_id}/sbom HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Service

get
Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "name": "text",
  "heeler_id": "text",
  "repository": "text",
  "status": "text",
  "application_path": "text",
  "param": "text",
  "source_type": "text",
  "source": {
    "id": 1,
    "owner": {
      "id": 1,
      "login": "text",
      "url": "text",
      "html_url": "text",
      "avatars_url": "text"
    },
    "name": "text",
    "full_name": "text",
    "org": "text",
    "description": "text",
    "default_branch": "text",
    "master_branch": "text",
    "created_at": "text",
    "updated_at": "text",
    "git_url": "text",
    "ssh_url": "text",
    "html_url": "text",
    "language": "text",
    "fork": true,
    "open_issues_count": 1,
    "size": 1,
    "archived": true,
    "disabled": true,
    "private": true,
    "git_commits_url": "text",
    "branch_count": 0,
    "githubContributors": [
      {
        "login": "text",
        "name": "text",
        "avatar_url": "text",
        "contributions": 1,
        "url": "text"
      }
    ],
    "heeler_id": "text"
  },
  "severity": "text",
  "tier": "TIER_4",
  "critical_findings_count": 1,
  "high_findings_count": 1,
  "medium_findings_count": 1,
  "low_findings_count": 1,
  "info_findings_count": 1,
  "findings_count": 1,
  "num_deployments": 1,
  "cloud_types": [],
  "accounts": [],
  "tech_leads": [
    {
      "id": 1,
      "name": "text",
      "email": "text",
      "alternate_emails": [
        "text"
      ],
      "is_hidden": true
    }
  ],
  "suggested_tech_leads": [
    {
      "identity": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "lines_of_code": 1,
      "last_commit_time": "2025-07-18T20:15:15.062Z"
    }
  ],
  "security_leads": [
    {
      "id": 1,
      "name": "text",
      "email": "text",
      "alternate_emails": [
        "text"
      ],
      "is_hidden": true
    }
  ],
  "latest_deployment_heeler_id": "text",
  "latest_deployed_time": "text",
  "latest_cset": "text",
  "latest_tags": [],
  "applications": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "service_count": 0,
      "resource_count": 0,
      "business_impact": "HIGH",
      "tier": "TIER_1",
      "application_type": "static",
      "tech_leads": [
        {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        }
      ],
      "security_leads": [
        {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        }
      ],
      "severity": "LOW",
      "created": "2025-07-18T20:15:15.062Z",
      "updated": "2025-07-18T20:15:15.062Z",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "services": [
        1
      ],
      "urgent": 0,
      "plan": 0,
      "defer": 0
    }
  ],
  "annotations": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "created": "text",
  "updated": "text",
  "description": "text",
  "project": {
    "project_id": "text",
    "name": "text",
    "key": "text",
    "source": "text",
    "connection_id": 1
  },
  "team": {
    "team_id": "text",
    "name": "text",
    "source": "text"
  },
  "project_ticket_type": {
    "ticket_type_id": "text",
    "name": "text",
    "image_url": "text"
  },
  "channel": {
    "name": "text",
    "source": "text",
    "connection_id": 1,
    "channel_id": "text"
  },
  "urgent": 0,
  "plan": 0,
  "defer": 0
}

Update Service Tier

put
Authorizations
Path parameters
service_idintegerRequired
Body
tierstringRequiredExample: TIER_1
Responses
200
Successful Response
application/json
Responseany
put
PUT /api/services/{service_id}/tier HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "tier": "TIER_1"
}
No content

Update Service Description

put
Authorizations
Path parameters
service_idintegerRequired
Body
descriptionstringRequired
Responses
200
Successful Response
application/json
Responseany
put
PUT /api/services/{service_id}/description HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 22

"description='text'"
No content

Get Service Deployments

get
Authorizations
Path parameters
service_idintegerRequired
Bodyany of[]
itemsany ofOptional
or
or
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/deployments HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]
[
  {
    "id": 1,
    "service_id": 1,
    "connection_id": 1,
    "environment": "text",
    "provider_id": "text",
    "display_name": "text",
    "cloud_type": "text",
    "heeler_id": "text",
    "status": "text",
    "last_seen": "text",
    "repository": {
      "source_id": "text",
      "source_changeset": "text",
      "source_type": "text",
      "tags": [],
      "html_url": "text"
    },
    "findings_count": 1,
    "critical_findings_count": 1,
    "high_findings_count": 1,
    "medium_findings_count": 1,
    "low_findings_count": 1,
    "info_findings_count": 1,
    "vuln_count": 1,
    "vuln_critical_count": 1,
    "vuln_high_count": 1,
    "vuln_medium_count": 1,
    "vuln_low_count": 1,
    "vuln_info_count": 1,
    "secret_count": 1,
    "secret_critical_count": 1,
    "secret_high_count": 1,
    "secret_low_count": 1,
    "secret_info_count": 1,
    "changeset_url": "text",
    "application_url": "text",
    "created": "text",
    "updated": "text",
    "deployment_type": "text",
    "deleted_at": "text",
    "correlation_proof": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "annotations": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "urgent": 0,
    "plan": 0,
    "defer": 0,
    "dns_names": [
      "text"
    ]
  }
]

Get Service Deployments

post
Authorizations
Path parameters
service_idintegerRequired
Bodyany of[]
itemsany ofOptional
or
or
Responses
200
Successful Response
application/json
post
POST /api/services/{service_id}/deployments HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]
[
  {
    "id": 1,
    "service_id": 1,
    "connection_id": 1,
    "environment": "text",
    "provider_id": "text",
    "display_name": "text",
    "cloud_type": "text",
    "heeler_id": "text",
    "status": "text",
    "last_seen": "text",
    "repository": {
      "source_id": "text",
      "source_changeset": "text",
      "source_type": "text",
      "tags": [],
      "html_url": "text"
    },
    "findings_count": 1,
    "critical_findings_count": 1,
    "high_findings_count": 1,
    "medium_findings_count": 1,
    "low_findings_count": 1,
    "info_findings_count": 1,
    "vuln_count": 1,
    "vuln_critical_count": 1,
    "vuln_high_count": 1,
    "vuln_medium_count": 1,
    "vuln_low_count": 1,
    "vuln_info_count": 1,
    "secret_count": 1,
    "secret_critical_count": 1,
    "secret_high_count": 1,
    "secret_low_count": 1,
    "secret_info_count": 1,
    "changeset_url": "text",
    "application_url": "text",
    "created": "text",
    "updated": "text",
    "deployment_type": "text",
    "deleted_at": "text",
    "correlation_proof": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "annotations": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "urgent": 0,
    "plan": 0,
    "defer": 0,
    "dns_names": [
      "text"
    ]
  }
]

Get Service Deps

get
Authorizations
Path parameters
service_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/dependencies HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "name": "text",
      "version": "text",
      "service_id": 1,
      "deployment_id": 1,
      "runtime": true,
      "code": true,
      "num_deployments": 1,
      "created": "text",
      "updated": "text",
      "cvss_priority_breakdown": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "overall_hygiene_score": 1,
      "language": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Service Dependency Graph

get
Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/dependencies/graph HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "nodes": [
    {
      "name": "text",
      "version": "text"
    }
  ],
  "edges": [
    {
      "source": 1,
      "target": 1,
      "requirement": "text"
    }
  ]
}

Get Service Deployment Sbom

get
Authorizations
Path parameters
service_idintegerRequired
deployment_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
get
GET /api/services/{service_id}/deployments/{deployment_id}/sbom HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Service Deployment

get
Authorizations
Path parameters
service_idintegerRequired
deployment_idintegerRequired
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/deployments/{deployment_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "service_id": 1,
  "connection_id": 1,
  "environment": "text",
  "provider_id": "text",
  "display_name": "text",
  "cloud_type": "text",
  "heeler_id": "text",
  "status": "text",
  "last_seen": "text",
  "repository": {
    "source_id": "text",
    "source_changeset": "text",
    "source_type": "text",
    "tags": [],
    "html_url": "text"
  },
  "findings_count": 1,
  "critical_findings_count": 1,
  "high_findings_count": 1,
  "medium_findings_count": 1,
  "low_findings_count": 1,
  "info_findings_count": 1,
  "vuln_count": 1,
  "vuln_critical_count": 1,
  "vuln_high_count": 1,
  "vuln_medium_count": 1,
  "vuln_low_count": 1,
  "vuln_info_count": 1,
  "secret_count": 1,
  "secret_critical_count": 1,
  "secret_high_count": 1,
  "secret_low_count": 1,
  "secret_info_count": 1,
  "changeset_url": "text",
  "application_url": "text",
  "created": "text",
  "updated": "text",
  "deployment_type": "text",
  "deleted_at": "text",
  "correlation_proof": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "annotations": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "urgent": 0,
  "plan": 0,
  "defer": 0,
  "dns_names": [
    "text"
  ]
}

Get Service Deployment Dependencies

get
Authorizations
Path parameters
service_idintegerRequired
deployment_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/deployments/{deployment_id}/dependencies HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "name": "text",
      "version": "text",
      "service_id": 1,
      "deployment_id": 1,
      "runtime": true,
      "code": true,
      "num_deployments": 1,
      "created": "text",
      "updated": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Service Deployment Vulns

get
Authorizations
Path parameters
service_idintegerRequired
deployment_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/deployments/{deployment_id}/vulnerabilities HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": 1,
      "service_id": "text",
      "deployment_id": "text",
      "package_name": "text",
      "package_version": "text",
      "vulnerability": {
        "vuln_id": "text",
        "title": "text",
        "description": "text",
        "severity": "CRITICAL",
        "severity_source": "text",
        "found": "2025-07-18T20:15:15.062Z",
        "status": "text",
        "fix_versions": [
          "text"
        ],
        "package_version": "text",
        "references": [
          "text"
        ],
        "cwe_ids": [
          "text"
        ],
        "cvss_source": "text",
        "cvss_v3": {
          "attack_vector": "N",
          "attack_complexity": "L",
          "privileges_required": "N",
          "user_interaction": "N",
          "scope": "U",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "exploit_code_maturity": "X",
          "remediation_level": "X",
          "report_confidence": "X",
          "base_score": 1,
          "base_severity": "CRITICAL",
          "base_vector": "text"
        },
        "cvss_v2": {
          "access_vector": "L",
          "access_complexity": "H",
          "authentication": "M",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "base_score": 1,
          "base_vector": "text",
          "base_severity": "CRITICAL"
        },
        "published_date": "text",
        "last_modified_date": "text",
        "vulnerable_versions": [
          "text"
        ],
        "patched_versions": [
          "text"
        ],
        "unaffected_versions": [
          "text"
        ],
        "exploitation": {
          "epss_score": 1,
          "epss_percentile": 1,
          "exploited": true,
          "ransomware": true,
          "level": "LIKELY_NOT_EXPLOITED"
        }
      },
      "created": "text",
      "updated": "text",
      "coded": "text",
      "coded_changeset": "text",
      "coded_dependency": {
        "reponame": "text",
        "name": "text",
        "version": "text",
        "owner": "text",
        "provider": "text",
        "lockfile": "text",
        "lockcommited": false,
        "startline": 1,
        "endline": 1,
        "url": "text"
      },
      "introduced_changeset": "text",
      "introduced": "2025-07-18T20:15:15.062Z",
      "introduced_dependency": {
        "reponame": "text",
        "name": "text",
        "version": "text",
        "owner": "text",
        "provider": "text",
        "lockfile": "text",
        "lockcommited": false,
        "startline": 1,
        "endline": 1,
        "url": "text"
      },
      "deployed": 1,
      "runtime": true,
      "sourcecode": true,
      "assignee": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      }
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Service Deployment Secrets

get
Authorizations
Path parameters
service_idintegerRequired
deployment_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/deployments/{deployment_id}/secrets HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": 1,
      "secret_id": "text",
      "service_id": "text",
      "deployment_id": "text",
      "num_deployments": 1,
      "target": "text",
      "start_line": 1,
      "end_line": 1,
      "match": "text",
      "created": "text",
      "updated": "text",
      "secret": {
        "rule_id": "text",
        "title": "text",
        "severity": "CRITICAL",
        "category": "text"
      },
      "coded": "text",
      "coded_changeset": "text",
      "deployed": 1,
      "affected_deployments": [
        1
      ],
      "introduced": "text",
      "introduced_changeset": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Service Vulnerabilities Terms

get

Get the terms for service vulns. Note that these terms are dynamic based on the supplied service.

Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/vulnerabilities/_terms HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "terms": [
    {
      "name": "text",
      "type": "Int",
      "terms": [
        {
          "lowerBound": 1,
          "upperBound": 1,
          "count": 1
        }
      ]
    }
  ]
}

Get Service Vulnerabilities Route

post
Authorizations
Path parameters
service_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
itemsany ofOptional
or
or
Responses
200
Successful Response
application/json
post
POST /api/services/{service_id}/vulnerabilities HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]
{
  "items": [
    {
      "id": 1,
      "package_name": "text",
      "package_versions": [
        "text"
      ],
      "vulnerability": {
        "vuln_id": "text",
        "title": "text",
        "description": "text",
        "severity": "CRITICAL",
        "severity_source": "text",
        "found": "2025-07-18T20:15:15.062Z",
        "status": "text",
        "fix_versions": [
          "text"
        ],
        "package_version": "text",
        "references": [
          "text"
        ],
        "cwe_ids": [
          "text"
        ],
        "cvss_source": "text",
        "cvss_v3": {
          "attack_vector": "N",
          "attack_complexity": "L",
          "privileges_required": "N",
          "user_interaction": "N",
          "scope": "U",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "exploit_code_maturity": "X",
          "remediation_level": "X",
          "report_confidence": "X",
          "base_score": 1,
          "base_severity": "CRITICAL",
          "base_vector": "text"
        },
        "cvss_v2": {
          "access_vector": "L",
          "access_complexity": "H",
          "authentication": "M",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "base_score": 1,
          "base_vector": "text",
          "base_severity": "CRITICAL"
        },
        "published_date": "text",
        "last_modified_date": "text",
        "vulnerable_versions": [
          "text"
        ],
        "patched_versions": [
          "text"
        ],
        "unaffected_versions": [
          "text"
        ],
        "exploitation": {
          "epss_score": 1,
          "epss_percentile": 1,
          "exploited": true,
          "ransomware": true,
          "level": "LIKELY_NOT_EXPLOITED"
        }
      },
      "created": "2025-07-18T20:15:15.062Z",
      "updated": "2025-07-18T20:15:15.062Z",
      "assignee": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "issues": [
        {
          "issue_id": 1,
          "name": "text",
          "status": "text",
          "status_category": "text",
          "issue_type": "text",
          "issue_type_icon_url": "text",
          "url": "text",
          "summary": "text",
          "remediation_id": 1
        }
      ],
      "service_id": "text",
      "num_deployments": 1,
      "coded": "text",
      "coded_changeset": "text",
      "coded_dependency": {
        "reponame": "text",
        "name": "text",
        "version": "text",
        "owner": "text",
        "provider": "text",
        "lockfile": "text",
        "lockcommited": false,
        "startline": 1,
        "endline": 1,
        "url": "text"
      },
      "introduced_changeset": "text",
      "introduced": "2025-07-18T20:15:15.062Z",
      "introduced_version": "text",
      "introduced_dependency": {
        "reponame": "text",
        "name": "text",
        "version": "text",
        "owner": "text",
        "provider": "text",
        "lockfile": "text",
        "lockcommited": false,
        "startline": 1,
        "endline": 1,
        "url": "text"
      },
      "affected_deployments": [
        {
          "heeler_id": "text",
          "provider_id": "text",
          "source_changeset": "text",
          "source_changeset_time": "2025-07-18T20:15:15.062Z",
          "repo_html_url": "text",
          "environment": "text",
          "deployment_type": "text",
          "cloud_type": "text",
          "account_id": "text",
          "account_name": "text",
          "fix_deployed": true,
          "vuln_count": 1,
          "secret_count": 1
        }
      ],
      "deployed_datetime": "2025-07-18T20:15:15.062Z",
      "affected_deployments_count": 0,
      "resolved_deployments_count": 0,
      "deployed": 1,
      "remediation": {
        "id": 1,
        "package_name": "text",
        "package_manager": "default",
        "title": "text",
        "created": "2025-07-18T20:15:15.062Z",
        "solutions": [
          {
            "action": "text",
            "details": "text",
            "fixed_vulnerabilities": [
              "text"
            ],
            "fix_version_range": "text",
            "fix_version": "text",
            "complexity": "easy",
            "type": "specific_version"
          }
        ],
        "assignee": {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        },
        "suggested_assignees": [
          {
            "identity": {
              "id": 1,
              "name": "text",
              "email": "text",
              "alternate_emails": [
                "text"
              ],
              "is_hidden": true
            },
            "lines_of_code": 1,
            "last_commit_time": "2025-07-18T20:15:15.062Z"
          }
        ],
        "service_id": 1,
        "service_name": "text",
        "affected_deployment_ids": [
          1
        ],
        "slo_seconds_remaining": 1,
        "slo_seconds_total": 1,
        "priority": "DEFER",
        "num_findings": 1,
        "issues": [
          {
            "issue_id": 1,
            "name": "text",
            "status": "text",
            "status_category": "text",
            "issue_type": "text",
            "issue_type_icon_url": "text",
            "url": "text",
            "summary": "text",
            "remediation_id": 1
          }
        ],
        "affected_versions": [
          "text"
        ],
        "resource_count": 1,
        "source_type": "The language of the service",
        "application_path": "The service application path.",
        "application_params": "The service application params.",
        "complexity": "The complexity of the remediation.",
        "findings": [
          "[Circular Reference]"
        ]
      },
      "source": "text",
      "affected_resources": 1,
      "priority": "DEFER",
      "business_impact": {
        "level": "LOW",
        "tier": "TIER_4",
        "environment": "text"
      },
      "environment_impact": {
        "level": "LOW",
        "accessibility": true,
        "accessibility_meta": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "compromise": "NONE",
        "compromise_meta": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "chaining": true,
        "chaining_meta": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "threat_impact": {
        "level": "LOW",
        "exploit": "LIKELY_NOT_EXPLOITED"
      },
      "slo_seconds_remaining": 1,
      "slo_seconds_total": 1,
      "evidence_graph": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Service Vulnerability Package Finding

get
Authorizations
Path parameters
service_idintegerRequired
vuln_idstringRequired
package_namestringRequired
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/vulnerabilities/{vuln_id}/package/{package_name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "package_name": "text",
  "package_versions": [
    "text"
  ],
  "vulnerability": {
    "vuln_id": "text",
    "title": "text",
    "description": "text",
    "severity": "CRITICAL",
    "severity_source": "text",
    "found": "2025-07-18T20:15:15.062Z",
    "status": "text",
    "fix_versions": [
      "text"
    ],
    "package_version": "text",
    "references": [
      "text"
    ],
    "cwe_ids": [
      "text"
    ],
    "cvss_source": "text",
    "cvss_v3": {
      "attack_vector": "N",
      "attack_complexity": "L",
      "privileges_required": "N",
      "user_interaction": "N",
      "scope": "U",
      "confidentiality_impact": "N",
      "integrity_impact": "N",
      "availability_impact": "N",
      "exploit_code_maturity": "X",
      "remediation_level": "X",
      "report_confidence": "X",
      "base_score": 1,
      "base_severity": "CRITICAL",
      "base_vector": "text"
    },
    "cvss_v2": {
      "access_vector": "L",
      "access_complexity": "H",
      "authentication": "M",
      "confidentiality_impact": "N",
      "integrity_impact": "N",
      "availability_impact": "N",
      "base_score": 1,
      "base_vector": "text",
      "base_severity": "CRITICAL"
    },
    "published_date": "text",
    "last_modified_date": "text",
    "vulnerable_versions": [
      "text"
    ],
    "patched_versions": [
      "text"
    ],
    "unaffected_versions": [
      "text"
    ],
    "exploitation": {
      "epss_score": 1,
      "epss_percentile": 1,
      "exploited": true,
      "ransomware": true,
      "level": "LIKELY_NOT_EXPLOITED"
    }
  },
  "created": "2025-07-18T20:15:15.062Z",
  "updated": "2025-07-18T20:15:15.062Z",
  "assignee": {
    "id": 1,
    "name": "text",
    "email": "text",
    "alternate_emails": [
      "text"
    ],
    "is_hidden": true
  },
  "issues": [
    {
      "issue_id": 1,
      "name": "text",
      "status": "text",
      "status_category": "text",
      "issue_type": "text",
      "issue_type_icon_url": "text",
      "url": "text",
      "summary": "text",
      "remediation_id": 1
    }
  ],
  "service_id": "text",
  "num_deployments": 1,
  "coded": "text",
  "coded_changeset": "text",
  "coded_dependency": {
    "reponame": "text",
    "name": "text",
    "version": "text",
    "owner": "text",
    "provider": "text",
    "lockfile": "text",
    "lockcommited": false,
    "startline": 1,
    "endline": 1,
    "url": "text"
  },
  "introduced_changeset": "text",
  "introduced": "2025-07-18T20:15:15.062Z",
  "introduced_version": "text",
  "introduced_dependency": {
    "reponame": "text",
    "name": "text",
    "version": "text",
    "owner": "text",
    "provider": "text",
    "lockfile": "text",
    "lockcommited": false,
    "startline": 1,
    "endline": 1,
    "url": "text"
  },
  "affected_deployments": [
    {
      "heeler_id": "text",
      "provider_id": "text",
      "source_changeset": "text",
      "source_changeset_time": "2025-07-18T20:15:15.062Z",
      "repo_html_url": "text",
      "environment": "text",
      "deployment_type": "text",
      "cloud_type": "text",
      "account_id": "text",
      "account_name": "text",
      "fix_deployed": true,
      "vuln_count": 1,
      "secret_count": 1
    }
  ],
  "deployed_datetime": "2025-07-18T20:15:15.062Z",
  "affected_deployments_count": 0,
  "resolved_deployments_count": 0,
  "deployed": 1,
  "remediation": {
    "id": 1,
    "package_name": "text",
    "package_manager": "default",
    "title": "text",
    "created": "2025-07-18T20:15:15.062Z",
    "solutions": [
      {
        "action": "text",
        "details": "text",
        "fixed_vulnerabilities": [
          "text"
        ],
        "fix_version_range": "text",
        "fix_version": "text",
        "complexity": "easy",
        "type": "specific_version"
      }
    ],
    "assignee": {
      "id": 1,
      "name": "text",
      "email": "text",
      "alternate_emails": [
        "text"
      ],
      "is_hidden": true
    },
    "suggested_assignees": [
      {
        "identity": {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        },
        "lines_of_code": 1,
        "last_commit_time": "2025-07-18T20:15:15.062Z"
      }
    ],
    "service_id": 1,
    "service_name": "text",
    "affected_deployment_ids": [
      1
    ],
    "slo_seconds_remaining": 1,
    "slo_seconds_total": 1,
    "priority": "DEFER",
    "num_findings": 1,
    "issues": [
      {
        "issue_id": 1,
        "name": "text",
        "status": "text",
        "status_category": "text",
        "issue_type": "text",
        "issue_type_icon_url": "text",
        "url": "text",
        "summary": "text",
        "remediation_id": 1
      }
    ],
    "affected_versions": [
      "text"
    ],
    "resource_count": 1,
    "source_type": "The language of the service",
    "application_path": "The service application path.",
    "application_params": "The service application params.",
    "complexity": "The complexity of the remediation.",
    "findings": [
      {
        "id": 1,
        "package_name": "text",
        "package_versions": [
          "text"
        ],
        "vulnerability": {
          "vuln_id": "text",
          "title": "text",
          "description": "text",
          "severity": "CRITICAL",
          "severity_source": "text",
          "found": "2025-07-18T20:15:15.062Z",
          "status": "text",
          "fix_versions": [
            "text"
          ],
          "package_version": "text",
          "references": [
            "text"
          ],
          "cwe_ids": [
            "text"
          ],
          "cvss_source": "text",
          "cvss_v3": {
            "attack_vector": "N",
            "attack_complexity": "L",
            "privileges_required": "N",
            "user_interaction": "N",
            "scope": "U",
            "confidentiality_impact": "N",
            "integrity_impact": "N",
            "availability_impact": "N",
            "exploit_code_maturity": "X",
            "remediation_level": "X",
            "report_confidence": "X",
            "base_score": 1,
            "base_severity": "CRITICAL",
            "base_vector": "text"
          },
          "cvss_v2": {
            "access_vector": "L",
            "access_complexity": "H",
            "authentication": "M",
            "confidentiality_impact": "N",
            "integrity_impact": "N",
            "availability_impact": "N",
            "base_score": 1,
            "base_vector": "text",
            "base_severity": "CRITICAL"
          },
          "published_date": "text",
          "last_modified_date": "text",
          "vulnerable_versions": [
            "text"
          ],
          "patched_versions": [
            "text"
          ],
          "unaffected_versions": [
            "text"
          ],
          "exploitation": {
            "epss_score": 1,
            "epss_percentile": 1,
            "exploited": true,
            "ransomware": true,
            "level": "LIKELY_NOT_EXPLOITED"
          }
        },
        "created": "2025-07-18T20:15:15.062Z",
        "updated": "2025-07-18T20:15:15.062Z",
        "assignee": {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        },
        "issues": [
          {
            "issue_id": 1,
            "name": "text",
            "status": "text",
            "status_category": "text",
            "issue_type": "text",
            "issue_type_icon_url": "text",
            "url": "text",
            "summary": "text",
            "remediation_id": 1
          }
        ],
        "service_id": "text",
        "num_deployments": 1,
        "coded": "text",
        "coded_changeset": "text",
        "coded_dependency": {
          "reponame": "text",
          "name": "text",
          "version": "text",
          "owner": "text",
          "provider": "text",
          "lockfile": "text",
          "lockcommited": false,
          "startline": 1,
          "endline": 1,
          "url": "text"
        },
        "introduced_changeset": "text",
        "introduced": "2025-07-18T20:15:15.062Z",
        "introduced_version": "text",
        "introduced_dependency": {
          "reponame": "text",
          "name": "text",
          "version": "text",
          "owner": "text",
          "provider": "text",
          "lockfile": "text",
          "lockcommited": false,
          "startline": 1,
          "endline": 1,
          "url": "text"
        },
        "affected_deployments": [
          {
            "heeler_id": "text",
            "provider_id": "text",
            "source_changeset": "text",
            "source_changeset_time": "2025-07-18T20:15:15.062Z",
            "repo_html_url": "text",
            "environment": "text",
            "deployment_type": "text",
            "cloud_type": "text",
            "account_id": "text",
            "account_name": "text",
            "fix_deployed": true,
            "vuln_count": 1,
            "secret_count": 1
          }
        ],
        "deployed_datetime": "2025-07-18T20:15:15.062Z",
        "affected_deployments_count": 0,
        "resolved_deployments_count": 0,
        "deployed": 1,
        "remediation": "[Circular Reference]",
        "source": "text",
        "affected_resources": 1,
        "priority": "DEFER",
        "business_impact": {
          "level": "LOW",
          "tier": "TIER_4",
          "environment": "text"
        },
        "environment_impact": {
          "level": "LOW",
          "accessibility": true,
          "accessibility_meta": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "compromise": "NONE",
          "compromise_meta": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "chaining": true,
          "chaining_meta": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "threat_impact": {
          "level": "LOW",
          "exploit": "LIKELY_NOT_EXPLOITED"
        },
        "slo_seconds_remaining": 1,
        "slo_seconds_total": 1,
        "evidence_graph": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ]
  },
  "source": "text",
  "affected_resources": 1,
  "priority": "DEFER",
  "business_impact": {
    "level": "LOW",
    "tier": "TIER_4",
    "environment": "text"
  },
  "environment_impact": {
    "level": "LOW",
    "accessibility": true,
    "accessibility_meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "compromise": "NONE",
    "compromise_meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "chaining": true,
    "chaining_meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "threat_impact": {
    "level": "LOW",
    "exploit": "LIKELY_NOT_EXPLOITED"
  },
  "slo_seconds_remaining": 1,
  "slo_seconds_total": 1,
  "evidence_graph": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get Service Vulnerability Finding Evidence

get
Authorizations
Path parameters
service_idintegerRequired
vuln_idstringRequired
Responses
200
Successful Response
application/json
Responseany
get
GET /api/services/{service_id}/vulnerabilities/{vuln_id}/evidence HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Service Vulnerability Finding Deployments

get
Authorizations
Path parameters
service_idintegerRequired
vuln_idstringRequired
Responses
200
Successful Response
application/json
Responseany
get
GET /api/services/{service_id}/vulnerabilities/{vuln_id}/deployments HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Service Remediated Findings

get
Authorizations
Path parameters
service_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/remediated/findings HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "service_id": "text",
      "finding_id": "text",
      "finding_type": "text",
      "created": "text",
      "updated": "text",
      "remediated": "text",
      "remediation": "text",
      "slo_seconds_remaining": 1,
      "slo_seconds_total": 1,
      "package_name": "text",
      "package_versions": [
        "text"
      ],
      "vulnerability": {
        "vuln_id": "text",
        "title": "text",
        "description": "text",
        "severity": "CRITICAL",
        "severity_source": "text",
        "found": "2025-07-18T20:15:15.062Z",
        "status": "text",
        "fix_versions": [
          "text"
        ],
        "package_version": "text",
        "references": [
          "text"
        ],
        "cwe_ids": [
          "text"
        ],
        "cvss_source": "text",
        "cvss_v3": {
          "attack_vector": "N",
          "attack_complexity": "L",
          "privileges_required": "N",
          "user_interaction": "N",
          "scope": "U",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "exploit_code_maturity": "X",
          "remediation_level": "X",
          "report_confidence": "X",
          "base_score": 1,
          "base_severity": "CRITICAL",
          "base_vector": "text"
        },
        "cvss_v2": {
          "access_vector": "L",
          "access_complexity": "H",
          "authentication": "M",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "base_score": 1,
          "base_vector": "text",
          "base_severity": "CRITICAL"
        },
        "published_date": "text",
        "last_modified_date": "text",
        "vulnerable_versions": [
          "text"
        ],
        "patched_versions": [
          "text"
        ],
        "unaffected_versions": [
          "text"
        ],
        "exploitation": {
          "epss_score": 1,
          "epss_percentile": 1,
          "exploited": true,
          "ransomware": true,
          "level": "LIKELY_NOT_EXPLOITED"
        }
      },
      "source": "text",
      "target": "text",
      "start_line": 1,
      "end_line": 1,
      "match": "text",
      "secret": {
        "rule_id": "text",
        "title": "text",
        "severity": "CRITICAL",
        "category": "text"
      },
      "coded": "text",
      "coded_changeset": "text",
      "coded_dependency": {
        "reponame": "text",
        "name": "text",
        "version": "text",
        "owner": "text",
        "provider": "text",
        "lockfile": "text",
        "lockcommited": false,
        "startline": 1,
        "endline": 1,
        "url": "text"
      },
      "introduced": "text",
      "introduced_changeset": "text",
      "introduced_dependency": {
        "reponame": "text",
        "name": "text",
        "version": "text",
        "owner": "text",
        "provider": "text",
        "lockfile": "text",
        "lockcommited": false,
        "startline": 1,
        "endline": 1,
        "url": "text"
      },
      "resolved_deployments": 1,
      "priority": "text",
      "business_impact": {
        "level": "LOW",
        "tier": "TIER_4",
        "environment": "text"
      },
      "environment_impact": {
        "level": "LOW",
        "accessibility": true,
        "accessibility_meta": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "compromise": "NONE",
        "compromise_meta": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "chaining": true,
        "chaining_meta": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "threat_impact": {
        "level": "LOW",
        "exploit": "LIKELY_NOT_EXPLOITED"
      },
      "evidence_graph": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Service Remediated Secrets

get
Authorizations
Path parameters
service_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/remediated/secrets HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": 1,
      "secret_id": "text",
      "service_id": "text",
      "deployment_id": "text",
      "num_deployments": 1,
      "target": "text",
      "start_line": 1,
      "end_line": 1,
      "match": "text",
      "created": "text",
      "updated": "text",
      "secret": {
        "rule_id": "text",
        "title": "text",
        "severity": "CRITICAL",
        "category": "text"
      },
      "coded": "text",
      "coded_changeset": "text",
      "deployed": 1,
      "affected_deployments": [
        1
      ],
      "introduced": "text",
      "introduced_changeset": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Service Secrets

get
Authorizations
Path parameters
service_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/secrets HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": 1,
      "secret_id": "text",
      "service_id": "text",
      "deployment_id": "text",
      "num_deployments": 1,
      "target": "text",
      "start_line": 1,
      "end_line": 1,
      "match": "text",
      "created": "text",
      "updated": "text",
      "secret": {
        "rule_id": "text",
        "title": "text",
        "severity": "CRITICAL",
        "category": "text"
      },
      "coded": "text",
      "coded_changeset": "text",
      "deployed": 1,
      "affected_deployments": [
        1
      ],
      "introduced": "text",
      "introduced_changeset": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Service Deployment Endpoints

get
Authorizations
Path parameters
service_idintegerRequired
deployment_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/deployments/{deployment_id}/endpoints HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "service_id": "text",
      "path": "text",
      "method": "text",
      "file_name": "text",
      "line_number": 1,
      "line_number_url": "text",
      "first_detected": "text",
      "last_detected": "text",
      "num_deployments": 1,
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Service Endpoint Terms

get

Get the terms for service endpoints. Note that these terms are dynamic based on the supplied service.

Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/endpoints/_terms HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "terms": [
    {
      "name": "text",
      "type": "Int",
      "terms": [
        {
          "lowerBound": 1,
          "upperBound": 1,
          "count": 1
        }
      ]
    }
  ]
}

Get Service Endpoints

post
Authorizations
Path parameters
service_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
itemsany ofOptional
or
or
Responses
200
Successful Response
application/json
post
POST /api/services/{service_id}/endpoints HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]
{
  "items": [
    {
      "service_id": "text",
      "path": "text",
      "method": "text",
      "file_name": "text",
      "line_number": 1,
      "line_number_url": "text",
      "first_detected": "text",
      "last_detected": "text",
      "num_deployments": 1,
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Service Summary Counts

get
Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/summary HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "dependencies": 1,
  "endpoints": 1,
  "connections": 1,
  "deployments": 1,
  "remediations": 1,
  "findings": 1,
  "secrets": 1
}

Get Service Compute

get
Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/compute HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "heeler_id": "text",
    "provider_id": "text",
    "name": "text",
    "region": "text",
    "resource_type": "text",
    "account_id": "text",
    "cloud_type": "text",
    "size": "text",
    "template": "text",
    "launch_time": "text",
    "deployment_id": 1,
    "source_changeset": "text",
    "account_name": "text",
    "environment": "text"
  }
]

Rescan Ecs Services

post
Authorizations
Path parameters
service_idintegerRequired
deployment_idintegerRequired
Responses
200
Successful Response
application/json
post
POST /api/services/{service_id}/deployments/{deployment_id}/rescan HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "terms": [
    {
      "name": "text",
      "type": "Int",
      "terms": [
        {
          "lowerBound": 1,
          "upperBound": 1,
          "count": 1
        }
      ]
    }
  ]
}

Get Threat Model

get
Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
get
GET /api/services/{service_id}/threat_model HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Generate Threat Model

post
Authorizations
Path parameters
service_idintegerRequired
Query parameters
frameworkstring · enumOptionalDefault: PASTAPossible values:
Responses
200
Successful Response
application/json
Responseany
post
POST /api/services/{service_id}/threat_model HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Set Service Owners

post
Authorizations
Path parameters
service_idintegerRequired
owner_typestring · enumRequiredPossible values:
Body
Responses
200
Successful Response
application/json
post
POST /api/services/{service_id}/owners/{owner_type} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "owners": [
    {
      "identity_id": 1
    }
  ]
}
{
  "ok": true,
  "message": "text"
}

Set Finding Assignee

post
Authorizations
Path parameters
service_idintegerRequired
vuln_idintegerRequired
Body
identity_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
post
POST /api/services/{service_id}/vulnerabilities/{vuln_id}/assignee HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "identity_id": 1
}
No content

Remove Finding Assignee

delete
Authorizations
Path parameters
service_idintegerRequired
vuln_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
delete
DELETE /api/services/{service_id}/vulnerabilities/{vuln_id}/assignee HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Set Service Project

post
Authorizations
Path parameters
service_idintegerRequired
Body
project_idstringRequired
connection_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
post
POST /api/services/{service_id}/project HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "project_id": "text",
  "connection_id": 1
}
No content

Remove Service Project

delete
Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
delete
DELETE /api/services/{service_id}/project HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Set Service Project Ticket Type

post
Authorizations
Path parameters
service_idintegerRequired
ticket_type_idstringRequired
Responses
200
Successful Response
application/json
Responseany
post
POST /api/services/{service_id}/project/ticket_type/{ticket_type_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Remove Service Project Ticket Type

delete
Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
delete
DELETE /api/services/{service_id}/project/ticket_type HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Set Service Team

post
Authorizations
Path parameters
service_idintegerRequired
team_idstringRequired
Responses
200
Successful Response
application/json
Responseany
post
POST /api/services/{service_id}/team/{team_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Remove Service Team

delete
Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
delete
DELETE /api/services/{service_id}/team HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Set Service Channel

post
Authorizations
Path parameters
service_idintegerRequired
Body
channel_idstringRequired
connection_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
post
POST /api/services/{service_id}/channel HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "channel_id": "text",
  "connection_id": 1
}
No content

Remove Service Channel

delete
Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
delete
DELETE /api/services/{service_id}/channel HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Semgrep Findings Count

get
Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
Responseinteger
get
GET /api/services/{service_id}/semgrep_findings_count HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

1

Get Semgrep Findings Count

post
Authorizations
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
Responseinteger
post
POST /api/services/{service_id}/semgrep_findings_count HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

1

Get Semgrep Rules

get
Authorizations
Path parameters
service_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/semgrep_findings HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "rule_name": "text",
      "rule_message": "text",
      "rule": {
        "category": "text",
        "confidence": "text",
        "cwe_names": [
          "text"
        ],
        "message": "text",
        "name": "text",
        "owasp_names": [
          "text"
        ],
        "subcategories": [
          "text"
        ],
        "vulnerability_classes": [
          "text"
        ]
      },
      "severity": "text",
      "categories": [
        "text"
      ],
      "finding_count": 1,
      "cwes": [
        {
          "id": "text",
          "title": "text"
        }
      ]
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Semgrep Rules

post
Authorizations
Path parameters
service_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
post
POST /api/services/{service_id}/semgrep_findings HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "rule_name": "text",
      "rule_message": "text",
      "rule": {
        "category": "text",
        "confidence": "text",
        "cwe_names": [
          "text"
        ],
        "message": "text",
        "name": "text",
        "owasp_names": [
          "text"
        ],
        "subcategories": [
          "text"
        ],
        "vulnerability_classes": [
          "text"
        ]
      },
      "severity": "text",
      "categories": [
        "text"
      ],
      "finding_count": 1,
      "cwes": [
        {
          "id": "text",
          "title": "text"
        }
      ]
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Semgrep Findings

get
Authorizations
Path parameters
service_idintegerRequired
rule_namestringRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
get
GET /api/services/{service_id}/semgrep_findings/{rule_name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "finding_id": 1,
      "file_name": "text",
      "line_number": 1,
      "line_of_code_url": "text",
      "relevant_since": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Semgrep Findings

post
Authorizations
Path parameters
service_idintegerRequired
rule_namestringRequired
Query parameters
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
post
POST /api/services/{service_id}/semgrep_findings/{rule_name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "finding_id": 1,
      "file_name": "text",
      "line_number": 1,
      "line_of_code_url": "text",
      "relevant_since": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}
PreviousRemediationsNextOss_libraries

Was this helpful?