{"id":24678726,"url":"https://github.com/contrast-security-oss/contrast-teamserver-api-docs","last_synced_at":"2026-01-05T03:38:25.662Z","repository":{"id":59775556,"uuid":"525789846","full_name":"Contrast-Security-OSS/contrast-teamserver-api-docs","owner":"Contrast-Security-OSS","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-14T14:31:11.000Z","size":821,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-14T15:40:09.506Z","etag":null,"topics":["fsg-ts"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Contrast-Security-OSS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-17T12:51:37.000Z","updated_at":"2025-03-14T14:31:13.000Z","dependencies_parsed_at":"2023-10-26T00:26:13.846Z","dependency_job_id":"580e4a15-fff5-496e-8e3d-f543ed7119bc","html_url":"https://github.com/Contrast-Security-OSS/contrast-teamserver-api-docs","commit_stats":null,"previous_names":[],"tags_count":445,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Contrast-Security-OSS%2Fcontrast-teamserver-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Contrast-Security-OSS%2Fcontrast-teamserver-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Contrast-Security-OSS%2Fcontrast-teamserver-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Contrast-Security-OSS%2Fcontrast-teamserver-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Contrast-Security-OSS","download_url":"https://codeload.github.com/Contrast-Security-OSS/contrast-teamserver-api-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244846020,"owners_count":20520066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fsg-ts"],"created_at":"2025-01-26T13:18:04.134Z","updated_at":"2026-01-05T03:38:25.637Z","avatar_url":"https://github.com/Contrast-Security-OSS.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Contrast Teamserver API Documentation\n\n## **Notice**\nThis documentation is for Contrast's Teamserver API. Documentation for other Contrast APIs can be accessed from [here](https://api.contrastsecurity.com).\n\n## Introduction\nContrast offers a HATEOAS-compliant RESTful API that allows you to gather nearly all of the same information that is accessible from the UI. \nYou can get vulnerability information, coverage data, download agents, and more through the API. \nOur goal is to offer the capability to allow complete integration with your Continuous Integration (CI), SIEM software, or other business intelligence dashboards.\n\nWe're always adding more endpoints, but if you'd like to see something added to the API, [file a ticket](https://support.contrastsecurity.com/hc/en-us/requests/new) and let's talk about it!\n\n## Using the Documentation\nContrast's RESTful API documentation provides resources to understand how to use the endpoints to help you authenticate, navigate, collect data, and take actions on TeamServer programmatically. \nSee the list under \"APIs\" at the bottom of this document to start drilling down into the information for a specific API.\n\n## Accessing the API\nTo begin using the Contrast API, you need your API key, Username, and Service Key:\n1) Log in to TeamServer \n2) Click the top right navigation's down arrow next to your name in the page header \n3) Your API Key and Service Key are at the bottom of the page under YOUR KEYS\n\nYour API key and authorization credentials are required in the request header to successfully call the API.\n\n| Header | Value |\n| ----- | ----- |\n| API-Key |\tThe API key in plaintext|\n| Authorization | Base64 encoded credential of \"username:service-key\" |\n| Accept | application/xml, application/json |\n\n### Example\nRequest:\n```shell\ncurl 'https://app.contrastsecurity.com/Contrast/api/ng/libraries/java/a10c06183fe21f3bb3dda3b5946b93db6e2ad5cc?expand=apps\u0026expand=vulns' \\\n\t\t-HAccept:application/json \\\n\t\t-HAuthorization:test \\\n\t\t-HAPI-Key:test\n```\nResponse\n```\n{\n  \"success\" : true,\n  \"messages\" : [ \"Library loaded successfully\" ],\n  \"library\" : {\n    \"grade\" : \"F\",\n    \"hash\" : \"a10c06183fe21f3bb3dda3b5946b93db6e2ad5cc\",\n    \"version\" : \"1.2\",\n    \"custom\" : false,\n    \"libScore\" : 0.0,\n    \"manifest\" : [ {\n    ...\n```\n\n## HATEOAS Links\nStarting v2, each API call response includes an array of HATEOAS (Hypermedia as the Engine of Application State) links. \nThe beauty of HATEOAS is that it allows you to interact and construct an API flow solely through the hyperlinks we provide. \nYou no longer need to hardcode logic into your client in order to use our API. \nWe provide HATEOAS links for each call and for transactions within a call, if available.\n\n| Element | Description |\n| --- | --- |\n| href | URL of the related HATEOAS link you can use for subsequent calls to the API |\n| rel | The relation of the link to the current resource you have retrieved. |\n| method | The HTTP method to use for the related call |\n\n### Example\n```\n{\n  \"links\": [\n    {\n      \"href\": \"https://app.contrastsecurity.com/Contrast/api/applications/c0d6b545-6377-483e-8b0c-f2e2e2aa8684\",\n      \"rel\": \"self\",\n      \"method\": \"GET\"\n    },\n    {\n      \"href\": \"https://app.contrastsecurity.com/Contrast/api/applications/c0d6b545-6377-483e-8b0c-f2e2e2aa8684/server\",\n      \"rel\": \"server\",\n      \"method\": \"GET\"\n    }\n  ]\n}\n```\n\n## Data Expansion\nStarting v2, any of the data enclosed in a HATEOAS link as a GET for a resource can be expanded to be included in the resource result itself. \nTo add a Data Expansion to an API call, add the expand parameter to the API Resource call. \nEach of the resources listed in this documentation lists the data available for expansion under the resource being queried.\n\n### Example\nRequest:\n```shell\ncurl https://app.contrastsecurity.com/Contrast/api/applications/c0d6b545-6377-483e-8b0c-f2e2e2aa8684/?expand=server \\\n\t\t-HAccept:application/json \\\n\t\t-HAuthorization:test \\\n\t\t-HAPI-Key:test\n```\nResponse:\n```\n[\n  {\n    \"links\": [ ... ],\n    \"app-id\": \"c0d6b545-6377-483e-8b0c-f2e2e2aa8684\",\n    \"name\": \"Test Applications\",\n    \"short-name\": \"Test\",\n    \"group-name\": null,\n    \"path\": \"/test\",\n    \"language\": \"Java\",\n    \"license\": \"Unlicensed\",\n    \"lastSeen\": 23472983488,\n    \"server\": {\n      \"server-id\": 1,\n      \"last-startup-message-received\": 2/27/2014 17:30:00,\n      ...\n    }\n  }\n]\n```\n## Paging and Filtering\nContrast API uses pagination to limit the size of response for endpoints that can potentially return large data. \nThe returned data set can be sorted by a specified data type and order. \nFiltering is also available. \nIn addition to text searching, there are pre-generated filters. \nSee the description of API endpoints for details.\n\n## APIs\n### [saas-restapi-v1](\u003c./saas-restapi-v1/README.md\u003e)\n### [saas-restapi-v2](\u003c./saas-restapi-v2/README.md\u003e)\n### [saas-restapi-v3](\u003c./saas-restapi-v3/README.md\u003e)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontrast-security-oss%2Fcontrast-teamserver-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcontrast-security-oss%2Fcontrast-teamserver-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontrast-security-oss%2Fcontrast-teamserver-api-docs/lists"}