Get application
/api/v1/app/{appId} 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.
| Parameter | Default | Description |
|---|---|---|
| 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:applicationpermission.
Path parameters
appIdstring · uuidrequiredUUID 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.
The UUID identifier of this application.
The status of this application. Either ACTIVE or ENV_INCOMPLETE.
2 available options
ACTIVEENV_INCOMPLETEThe type of this application.
2 available options
STANDARDCLOUDThe perceived dataType of this application. Currently unused.
7 available options
NONEPIIPCIFINPKIHIPAAFERPAThe name of this environment. Only set when requesting Application Environments.
The UUID identifier of this environment.
The name of this application.
The UUID identifier of the organization that owns this application.
The perceived riskLevel of this application. Currently unused.
4 available options
LOWMEDIUMHIGHCRITICALThe UUID identifier of this application.
The status of this application. Either ACTIVE or ENV_INCOMPLETE.
2 available options
ACTIVEENV_INCOMPLETEThe type of this application.
2 available options
STANDARDCLOUDThe perceived dataType of this application. Currently unused.
7 available options
NONEPIIPCIFINPKIHIPAAFERPAThe name of this environment. Only set when requesting Application Environments.
The UUID identifier of this environment.
The name of this application.
The UUID identifier of the organization that owns this application.
The perceived riskLevel of this application. Currently unused.
4 available options
LOWMEDIUMHIGHCRITICALBad Request
Unauthorized