https://github.com/fortify/ssc-restapi-client
Communicate with Fortify Software Security Center through REST API in java, a swagger generated client
https://github.com/fortify/ssc-restapi-client
api api-client application-security fortify fortify-api fortify-ssc integration openapi security
Last synced: 5 months ago
JSON representation
Communicate with Fortify Software Security Center through REST API in java, a swagger generated client
- Host: GitHub
- URL: https://github.com/fortify/ssc-restapi-client
- Owner: fortify
- License: mit
- Created: 2019-01-29T22:18:22.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-06-30T13:55:06.000Z (7 months ago)
- Last Synced: 2025-06-30T17:02:35.143Z (7 months ago)
- Topics: api, api-client, application-security, fortify, fortify-api, fortify-ssc, integration, openapi, security
- Homepage:
- Size: 1.04 MB
- Stars: 18
- Watchers: 6
- Forks: 17
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ssc-restapi-client
# Fortify Software Security Center REST API java client
Communicate with Fortify Software Security Center through REST API in java, a swagger generated client
- API version: 1:25.2.0.0151
## Generation:
To run swagger generator and produce the library, simply run
```shell
gradlew clean build
```
When you build this project it will use [./src/swagger/spec.json] to generate a source code
to communicate with Fortify SSC using REST, then compile it into a jar library
and prepare for publishing to Maven central.
You can download spec.json from your working Fortify Software Security Center on the API Reference page.
## Installation
### Maven users
Add this dependency to your project's POM:
```xml
com.fortify
ssc-restapi-client
25.2
compile
```
### Gradle users
Add this dependency to your project's build file:
```groovy
compile "com.fortify:ssc-restapi-client:25.2"
```
## Getting Started
Please follow the [installation](#installation) instruction and execute the following Java code:
```java
import com.fortify.ssc.restclient.*;
import com.fortify.ssc.restclient.auth.*;
import com.fortify.ssc.restclient.model.*;
import com.fortify.ssc.restclient.api.AaTrainingStatusOfProjectVersionControllerApi;
import java.io.File;
import java.util.*;
public class AaTrainingStatusOfProjectVersionControllerApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");
AaTrainingStatusOfProjectVersionControllerApi apiInstance = new AaTrainingStatusOfProjectVersionControllerApi();
Long parentId = 789L; // Long | parentId
String fields = "fields_example"; // String | Output fields
try {
ApiResultListAATrainingStatus result = apiInstance.listAaTrainingStatusOfProjectVersion(parentId, fields);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AaTrainingStatusOfProjectVersionControllerApi#listAaTrainingStatusOfProjectVersion");
e.printStackTrace();
}
}
}
```
## Documentation for Authorization
Authentication schemes defined for the API:
### Basic
- **Type**: HTTP basic authentication
### FortifyToken
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
## Compatibility:
The first two digits of the ssc-restapi-client version correspond to the version of SSC where the REST API specification has been pulled from. The last digit is reserved for fixing problems with this library itself, it does not affect compatibility.
SSC API was designed with backwards compatibility in mind, so you are most likely should be able to use the newer client with an older SSC (and vice versa). Not all features may be available in this case.
## Recommendation
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
## Author
Fortify R&D