v2

latestOpenAPI 3.0.1private2026-07-2667209320.4 KB
Applications

Get application

Get Application

Gets this StackHawk Application.

Applications group scan results from HawkScan, and coordinate settings to influence HawkScan behavior. The application may also contain a specific environment name and id. For more information, see Applications.

ParameterDefaultDescription
applicationId""The UUID identifier of this application.
name""The name of this application.
env""The name of this environment. Only set when requesting Application Environments.
envId""The UUID identifier of this environment.
applicationStatus"ACTIVE"The status of this application. Either ACTIVE or ENV_INCOMPLETE.
organizationId""The UUID identifier of the organization that owns this application.
applicationType"STANDARD"The type of this application.
cloudScanTarget{}Optional Cloud Scan Target configuration.
{
	"applicationId": "",
	"name": "",
	"env": "",
	"envId": "",
	"applicationStatus": "UNKNOWN",
	"organizationId": "",
	"applicationType": "UNKNOWN",
	"cloudScanTarget": {}
}
const application = {
	applicationId: "",
	name: "",
	env: "",
	envId: "",
	applicationStatus: "UNKNOWN",
	organizationId: "",
	applicationType: "UNKNOWN",
	cloudScanTarget: {},
}
interface Application {
	applicationId: string
	name: string
	env: string
	envId: string
	applicationStatus: ApplicationApplicationStatus
	organizationId: string
	applicationType: ApplicationApplicationType
	cloudScanTarget: ApplicationCloudScanTarget
} 

const application: Application = {
	applicationId: "",
	name: "",
	env: "",
	envId: "",
	applicationStatus: "UNKNOWN",
	organizationId: "",
	applicationType: "UNKNOWN",
	cloudScanTarget: {},
}
public class Application {

	public String applicationId;
	public String name;
	public String env;
	public String envId;
	public ApplicationApplicationStatus applicationStatus;
	public String organizationId;
	public ApplicationApplicationType applicationType;
	public ApplicationCloudScanTarget cloudScanTarget;

}
data class Application(
	var applicationId: String,
	var name: String,
	var env: String,
	var envId: String,
	var applicationStatus: ApplicationApplicationStatus,
	var organizationId: String,
	var applicationType: ApplicationApplicationType,
	var cloudScanTarget: ApplicationCloudScanTarget
)
class Application:
	applicationId = ""
	name = ""
	env = ""
	envId = ""
	applicationStatus = "UNKNOWN"
	organizationId = ""
	applicationType = "UNKNOWN"
	cloudScanTarget = {}
struct Application {
	applicationId: &str,
	name: &str,
	env: &str,
	envId: &str,
	applicationStatus: ApplicationApplicationStatus,
	organizationId: &str,
	applicationType: ApplicationApplicationType,
	cloudScanTarget: ApplicationCloudScanTarget,
}

👥 Teams Supported If the application belongs to a StackHawk Team, only members of the Team can call this endpoint.

Requires read:application permission.

get/api/v1/app/{appId}

Path parameters

appIdstring uuid required

UUID identifier for this StackHawk Application.

Response

Applications group scan results from HawkScan, and coordinate settings to influence HawkScan behavior. The application may also contain a specific environment name and id. For more information, see Applications.

applicationIdstring

The UUID identifier of this application.

applicationStatus'ACTIVE' | 'ENV_INCOMPLETE'

The status of this application. Either ACTIVE or ENV_INCOMPLETE.

applicationType'STANDARD' | 'CLOUD'

The type of this application.

dataType'NONE' | 'PII' | 'PCI' | 'FIN' | 'PKI' | 'HIPAA' | 'FERPA'

The perceived dataType of this application. Currently unused.

envstring

The name of this environment. Only set when requesting Application Environments.

envIdstring

The UUID identifier of this environment.

namestring

The name of this application.

organizationIdstring

The UUID identifier of the organization that owns this application.

riskLevel'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL'

The perceived riskLevel of this application. Currently unused.