Validate settings for an existing codebase

post

https://sentinel.whitehatsec.com/api/application/{application_id}/codebase/{codebase_id}/repotest

This operation enables you to determine if a satellite device is connected, and if the configuration (authorization & repository information) is correct for a particular codebase for an application. For this operation, the codebase MUST exist.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

application_id

int32

required

Application ID.

codebase_id

int32

required

Codebase ID.

Query Params

format

string

enum

Defaults to json

Data format for results.

Allowed:

Body Params

Holds the information to validate settings for an existing codebase.

repository_revision

string

required

Codebase repository revision. EXAMPLE: 'HEAD' (git)

repository_uri

string

The Uniform Resource Identifier (URI) of the repository for this codebase. EXAMPLES: 'file:///usr/local/repos/java-repo', 'https://repos.mycompany.lan/svn/myapp'.

repository_type

string

enum

required

Defaults to git

Type of source code repository. The 'mock' repository type is used for HTTP & SFTP checkouts.

Allowed:

auth_type

string

enum

The type of authentication desired in order to access this codebase's repository. Authentication by 'password' requires a username and password. Authentication by 'certificate' requires a username and certificate. Authentication by 'token' requires a repository of type 'mock'.

Allowed:

username

string

Username required to authenticate access to this codebase's repository. Does not need to be a Sentinel username, just a username for someone who can access the repo. PREREQUISITE: An auth_type of 'password' or 'certificate', and a password or certificate associated with this username. The username field cannot be an empty string.

password

string

Password required to authenticate access to this codebase's repository. PREREQUISITE: An auth_type of 'password' and a username associated with this password. The password field cannot be an empty string.

certificate

string

Certificate key required to authenticate access this codebase's repository. PREREQUISITE: An auth_type of 'certificate' and a username associated with this certificate. The certificate field cannot be an empty string.

token

string

Token key required to authenticate access this codebase's repository. PREREQUISITE: An auth_type of 'token' and repository_type of 'mock' is required. The token field cannot be an empty string.

Responses

400

BadRequestResponse indicates a request with invalid parameters.

401

UnauthorizedResponse signals an unauthorized API access.

403

ForbiddenResponse signals a request for a resource that does not exist or is not authorized.

404

NotFound The requested resource could not be found.

409

Conflict indicates that the request could not be processed because of conflict in the request, such as an edit conflict.

500

GenericError generic error.

Language

Loading…

Response

Choose an example:

application/json

201Provides the information of validated settings for an existing codebase.