ContrastRestClient 2.2.1
See the version list below for details.
dotnet add package ContrastRestClient --version 2.2.1
NuGet\Install-Package ContrastRestClient -Version 2.2.1
<PackageReference Include="ContrastRestClient" Version="2.2.1" />
paket add ContrastRestClient --version 2.2.1
#r "nuget: ContrastRestClient, 2.2.1"
// Install ContrastRestClient as a Cake Addin
#addin nuget:?package=ContrastRestClient&version=2.2.1
// Install ContrastRestClient as a Cake Tool
#tool nuget:?package=ContrastRestClient&version=2.2.1
Contrast REST Client
This library provides a simple REST client for retrieving data from Contrast Team Server's REST API as plain old C# objects.
This library is also provided as a nuget package: https://www.nuget.org/packages/ContrastRestClient/.
Please see http://www.contrastsecurity.com for more information about how Contrast can help secure your applications.
Dependencies
- Newtonsoft.Json
Contrast TeamServer API Credentials
To access the TeamServer API, you'll first need access to TeamServer - either SAAS (https://app.contrastsecurity.com/Contrast/login.html) or an on-premises installation of TeamServer.
To begin using the Contrast API you will need to retrieve your API-Key from the server. To do this, you will need to log in to your TeamServer account and have the application e-mail you a generated API-Key.
- Log in to TeamServer
- Click the down arrow next to your login name in the page header
- Click on API Key
- Click either Email me the current "API Key" or "Rotate the key and email me a new key"
The TeamServer client requires the TeamServer URL, account username, service key, API key and TeamServer URL.
More API documentation can be found here: https://support.contrastsecurity.com/entries/24184140-Accessing-the-API
Sample Client Application
The SampleContrastClient uses the App.config to store API credentials. To use the sample application, copy the API values from above into the appropriate appSettings entries:
<appSettings>
<add key="TeamServerUrl" value="https://app.contrastsecurity.com/Contrast/"/>
<add key="TeamServerUserName" value=""/>
<add key="TeamServerApiKey" value=""/>
<add key="TeamServerServiceKey" value=""/>
</appSettings>
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET Framework | net452 is compatible. net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
-
- Newtonsoft.Json (>= 10.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Fixed Agents urls.