2022-06-30
▼ ▲ apigee.organizations.securityProfiles.get
Path: v1/{+name}
HTTP Method: GET
Flat Path: v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}
Description: GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization.
Parameters:
name
Type: string
Pattern: ^organizations/[^/]+/securityProfiles/[^/]+$
Required: Yes
Location: path
Description: Required. Security profile in the following format: `organizations/{org}/securityProfiles/{profile}'. Profile may optionally contain revision ID. If revision ID is not provided, the response will contain latest revision by default. Example: organizations/testOrg/securityProfiles/testProfile@5
Parameter Order: name
▼ ▲ apigee.organizations.securityProfiles.listRevisions
Parameter Order: name
Parameters:
pageToken
Type: string
Location: query
Description: A page token, received from a previous `ListSecurityProfileRevisions` call. Provide this to retrieve the subsequent page.
name
Location: path
Pattern: ^organizations/[^/]+/securityProfiles/[^/]+$
Required: Yes
Description: Required. For a specific profile, list all the revisions. Format: `organizations/{org}/securityProfiles/{profile}`
Type: string
pageSize
Type: integer
Description: The maximum number of profile revisions to return. The service may return fewer than this value. If unspecified, at most 50 revisions will be returned.
Format: int32
Location: query
Description: ListSecurityProfileRevisions lists all the revisions of the security profile.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1/{+name}:listRevisions
Flat Path: v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}:listRevisions
▼ ▲ apigee.organizations.securityProfiles.list
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1/{+parent}/securityProfiles
Description: ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.
Parameters:
pageToken
Type: string
Description: A page token, received from a previous `ListSecurityProfiles` call. Provide this to retrieve the subsequent page.
Location: query
pageSize
Location: query
Description: The maximum number of profiles to return. The service may return fewer than this value. If unspecified, at most 50 profiles will be returned.
Type: integer
Format: int32
parent
Description: Required. For a specific organization, list of all the security profiles. Format: `organizations/{org}`
Pattern: ^organizations/[^/]+$
Type: string
Location: path
Required: Yes
Flat Path: v1/organizations/{organizationsId}/securityProfiles
▼ ▲ apigee.organizations.securityProfiles.environments.computeEnvironmentScores
Flat Path: v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}:computeEnvironmentScores
Description: ComputeEnvironmentScores calculates scores for requested time range for the specified security profile and environment.
Parameter Order: profileEnvironment
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
profileEnvironment
Required: Yes
Pattern: ^organizations/[^/]+/securityProfiles/[^/]+/environments/[^/]+$
Description: Required. Name of organization and environment and profile id for which score needs to be computed. Format: organizations/{org}/securityProfiles/{profile}/environments/{env}
Type: string
Location: path
Path: v1/{+profileEnvironment}:computeEnvironmentScores
▼ ▲ apigee.organizations.securityProfiles.environments.create
Parameter Order: parent
Path: v1/{+parent}/environments
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Description: Required. Name of organization and security profile ID. Format: organizations/{org}/securityProfiles/{profile}
Required: Yes
Location: path
Pattern: ^organizations/[^/]+/securityProfiles/[^/]+$
Type: string
Description: CreateSecurityProfileEnvironmentAssociation creates profile environment association i.e. attaches environment to security profile.
HTTP Method: POST
Flat Path: v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments
▼ ▲ apigee.organizations.securityProfiles.environments.delete
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: DeleteSecurityProfileEnvironmentAssociation removes profile environment association i.e. detaches environment from security profile.
Parameters:
name
Required: Yes
Pattern: ^organizations/[^/]+/securityProfiles/[^/]+/environments/[^/]+$
Location: path
Type: string
Description: Required. The name of the environment attachment to delete. Format: organizations/{org}/securityProfiles/{profile}/environments/{env}
HTTP Method: DELETE
Flat Path: v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}
Path: v1/{+name}
▼ ▲ apigee.organizations.environments.securityReports.list
Flat Path: v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports
Parameters:
status
Type: string
Description: Filter response list by security reports status.
Location: query
pageToken
Type: string
Description: Token returned from the previous list response to fetch the next page.
Location: query
to
Location: query
Type: string
Description: Filter response list by returning security reports that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.
dataset
Description: Filter response list by dataset. Example: `api`, `mint`
Type: string
Location: query
parent
Pattern: ^organizations/[^/]+/environments/[^/]+$
Description: Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.
Type: string
Required: Yes
Location: path
submittedBy
Description: Filter response list by user who submitted queries.
Location: query
Type: string
from
Description: Filter response list by returning security reports that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.
Type: string
Location: query
pageSize
Type: integer
Location: query
Format: int32
Description: The maximum number of security report to return in the list response.
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Return a list of Security Reports
Parameter Order: parent
Path: v1/{+parent}/securityReports
HTTP Method: GET
▼ ▲ apigee.organizations.environments.securityReports.get
HTTP Method: GET
Description: Get security report status If the query is still in progress, the `state` is set to "running" After the query has completed successfully, `state` is set to "completed"
Flat Path: v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}
Parameter Order: name
Path: v1/{+name}
Parameters:
name
Pattern: ^organizations/[^/]+/environments/[^/]+/securityReports/[^/]+$
Required: Yes
Type: string
Description: Required. Name of the security report to get. Must be of the form `organizations/{org}/environments/{env}/securityReports/{reportId}`.
Location: path
▼ ▲ apigee.organizations.environments.securityReports.getResult
Flat Path: v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/result
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Pattern: ^organizations/[^/]+/environments/[^/]+/securityReports/[^/]+/result$
Description: Required. Name of the security report result to get. Must be of the form `organizations/{org}/environments/{env}/securityReports/{reportId}/result`.
Required: Yes
Type: string
Description: After the query is completed, use this API to retrieve the results as file. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip`
HTTP Method: GET
Path: v1/{+name}
▼ ▲ apigee.organizations.environments.securityReports.getResultView
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameters:
name
Type: string
Description: Required. Name of the security report result view to get. Must be of the form `organizations/{org}/environments/{env}/securityReports/{reportId}/resultView`.
Location: path
Required: Yes
Pattern: ^organizations/[^/]+/environments/[^/]+/securityReports/[^/]+/resultView$
Description: After the query is completed, use this API to view the query result when result size is small.
Flat Path: v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/resultView
HTTP Method: GET
▼ ▲ apigee.organizations.environments.securityReports.create
Description: Submit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report request. In addition to the HTTP status 200, the `state` of "enqueued" means that the request succeeded.
Path: v1/{+parent}/securityReports
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
parent
Type: string
Location: path
Pattern: ^organizations/[^/]+/environments/[^/]+$
Required: Yes
Description: Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.
Parameter Order: parent
Flat Path: v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports
▼ ▲ apigee.organizations.hostSecurityReports.create
Path: v1/{+parent}/hostSecurityReports
HTTP Method: POST
Description: Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the `state` of "enqueued" means that the request succeeded.
Flat Path: v1/organizations/{organizationsId}/hostSecurityReports
Parameters:
parent
Required: Yes
Pattern: ^organizations/[^/]+$
Description: Required. The parent resource name. Must be of the form `organizations/{org}`.
Type: string
Location: path
Parameter Order: parent
▼ ▲ apigee.organizations.hostSecurityReports.get
Path: v1/{+name}
Flat Path: v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Required: Yes
Description: Required. Name of the security report to get. Must be of the form `organizations/{org}/securityReports/{reportId}`.
Type: string
Pattern: ^organizations/[^/]+/hostSecurityReports/[^/]+$
Description: Get status of a query submitted at host level. If the query is still in progress, the `state` is set to "running" After the query has completed successfully, `state` is set to "completed"
Parameter Order: name
HTTP Method: GET
▼ ▲ apigee.organizations.hostSecurityReports.getResultView
Parameters:
name
Location: path
Description: Required. Name of the security report result view to get. Must be of the form `organizations/{org}/securityReports/{reportId}/resultView`.
Type: string
Required: Yes
Pattern: ^organizations/[^/]+/hostSecurityReports/[^/]+/resultView$
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/resultView
Description: After the query is completed, use this API to view the query result when result size is small.
Path: v1/{+name}
HTTP Method: GET
▼ ▲ apigee.organizations.hostSecurityReports.getResult
Flat Path: v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/result
Parameter Order: name
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Location: path
Pattern: ^organizations/[^/]+/hostSecurityReports/[^/]+/result$
Required: Yes
Description: Required. Name of the security report result to get. Must be of the form `organizations/{org}/securityReports/{reportId}/result`.
Description: After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip`
Path: v1/{+name}
▼ ▲ apigee.organizations.hostSecurityReports.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/hostSecurityReports
Description: Return a list of Security Reports at host level.
Parameter Order: parent
Flat Path: v1/organizations/{organizationsId}/hostSecurityReports
HTTP Method: GET
Parameters:
parent
Pattern: ^organizations/[^/]+$
Location: path
Type: string
Description: Required. The parent resource name. Must be of the form `organizations/{org}`.
Required: Yes
to
Description: Filter response list by returning security reports that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.
Type: string
Location: query
submittedBy
Type: string
Description: Filter response list by user who submitted queries.
Location: query
pageSize
Type: integer
Description: The maximum number of security report to return in the list response.
Location: query
Format: int32
envgroupHostname
Description: Required. Filter response list by hostname.
Type: string
Location: query
status
Location: query
Type: string
Description: Filter response list by security report status.
pageToken
Type: string
Location: query
Description: Token returned from the previous list response to fetch the next page.
dataset
Location: query
Description: Filter response list by dataset. Example: `api`, `mint`
Type: string
from
Description: Filter response list by returning security reports that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.
Location: query
Type: string