Manage monitoring conditions for multiple Apigee organizations and gateways

Console

To view the list of existing monitoring condition configurations, go to the API hub > Risk assessment page and select the Monitoring conditions tab.

Select the gateway for which you want to view the list of monitoring conditions from the Gateway selector at the top of the page.

To view the details of a specific monitoring condition, including which deployments are monitored, click the Monitored deployments/total deployed value in the row for that security profile. The following monitoring condition details display:

• Gateway: the gateway or gateways where the monitoring condition applies. This field also shows your Apigee project name.
• Security profile: the monitored security profile.
• Fetched data time: the local date and time when the monitoring data was fetched.
• Deployments: the monitored deployments.
  • Deployment: the deployment name.
  • Source environment: the environment where the proxy is deployed.
  • Status: the status of the deployment. If a deployment is monitored, it has a Monitored status. Otherwise, it has a Not Monitored status.

REST

To view the list of configured monitoring conditions, make a GET request to the securityMonitoringConditions API.

curl "https://apigee.googleapis.com/v1/organizations/ APIGEE_ORG 
/securityMonitoringConditions?risk_assessment_type=API_HUB" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

To view the list of monitoring conditions for a specific gateway, send a GET request as follows:

curl "https://apigee.googleapis.com/v1/organizations/ APIGEE_ORG 
/securityMonitoringConditions?risk_assessment_type=API_HUB&filter=api_hub_gateway%3D GATEWAY_ID 
" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

To view the list of monitoring conditions for a specific security profile, send a GET request as follows:

curl "https://apigee.googleapis.com/v1/organizations/ APIGEE_ORG 
/securityMonitoringConditions?risk_assessment_type=API_HUB&filter=profile%3D PROFILE_ID 
" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

To see details on a specific monitoring condition, use the following GET request:

curl "https://apigee.googleapis.com/v1/organizations/ APIGEE_ORG 
/securityMonitoringConditions/ CONDITION_ID 
?risk_assessment_type=API_HUB" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Replace the following:

• APIGEE_ORG : Name of the Apigee organization provisioned in your Google Cloud project.
• GATEWAY_ID : The name of the gateway. One of: apigee-x , apigee-hybrid , apigee-edge-cloud , apigee-edge-private-cloud .
• PROFILE_ID : The name of the security profile.
• CONDITION_ID : The ID of the monitoring condition.

Console

To create a monitoring condition:

1. In the Google Cloud console, go to the API hub > Risk assessment page.

   Go to Risk assessment

2. In the Risk assessment page, click the Monitoring conditions tab.
3. Select the gateway for which you want to create the monitoring condition from the Gateway selector at the top of the page.
4. Click add_box Create monitoring condition . The Create monitoring condition panel appears.
5. The Gateway field shows the gateway or gateways where the monitoring condition will apply. This field also shows your Apigee project name. The Gateway field is auto-populated based on your Gateway selection in the main page and is not editable.
6. Select a Security profile .
7. In the Deployments to monitor section, select whether to include all deployments or selected deployments:
   • Monitor all deployments (current and future): selects all current and future deployments in the Apigee project.
   • Monitor specific deployments: monitors only the deployments you select from the list.
8. Click Create to save your changes or Close to exit without saving changes.

   The monitoring condition is created and you are returned to the Monitoring conditions tab.

REST

To create a monitoring condition, make a POST request to the securityMonitoringConditions API. When creating a monitoring condition, you must set risk_assessment_type to API_HUB .

curl "https://apigee.googleapis.com/v1/organizations/ APIGEE_ORG 
/securityMonitoringConditions?security_monitoring_condition_id= CONDITION_ID 
" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "profile": " PROFILE_ID 
",
    "risk_assessment_type": "API_HUB",
    "api_hub_gateway": " GATEWAY_NAME 
",
    "include_all_resources": {}
  }'

Replace the following:

• APIGEE_ORG : Name of the Apigee organization provisioned in your Google Cloud project.
• CONDITION_ID : The ID of the monitoring condition.
• PROFILE_ID : The name of the security profile.
• GATEWAY_NAME : The full resource name of the gate (plugin instance). For example, projects/sense-staging-test/locations/us-west1/plugins/system-apigee-x-and-hybrid/instances/2b355bf9-4466-484b-afbe-e50916940762 .

Console

To edit a monitoring condition, do the following:

1. Go to the API hub > Risk assessment page.

   Go to Risk assessment

2. In the Risk assessment page, click the Monitoring conditions tab.
3. Select the gateway for which you want to edit the monitoring condition from the Gateway selector at the top of the page.
4. Find the monitoring condition that you want to edit in the table shown.
5. In the row for the monitoring condition, select Edit in the Actions menu.
6. In the Edit monitoring condition panel, make the required edits to the assessment configurations. Only the selected deployments can be edited. If you need to edit other settings such as the security profile, create a new monitoring condition instead of editing.
7. Click Save to save your changes.

REST

To edit a monitoring condition, make a PATCH request to the securityMonitoringConditions API. You can use update_mask to specify which field to update. The update_mask could be empty (which defaults to all non-empty fields set in the request), or one of the following: include , include_all_resources , or * (everything). This example uses an update mask to update a monitoring condition so that it includes specific deployments instead of all deployments.

curl "https://apigee.googleapis.com/v1/organizations/ APIGEE_ORG 
/securityMonitoringConditions/ CONDITION_ID 
?update_mask=include" \
  -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "risk_assessment_type": "API_HUB",
    "include": {
      "resources": [
        {
          "type": "API_HUB_DEPLOYMENT",
          "name": " DEPLOYMENT_ID_1 
"
        },
        {
          "type": "API_HUB_DEPLOYMENT",
          "name": " DEPLOYMENT_ID_2 
"
        }
      ]
    }
  }'

Replace the following:

• APIGEE_ORG : Name of the Apigee organization provisioned in your Google Cloud project.
• CONDITION_ID : The ID of the monitoring condition. Obtain the condition ID by using List monitoring conditions .
• DEPLOYMENT_ID_1 , DEPLOYMENT_ID_2 : The names of the deployments to monitor.

Console

To delete a monitoring condition, do the following:

1. Go to the API hub > Risk assessment page.

   Go to Risk assessment

2. In the Risk assessment page, click the Monitoring conditions tab.
3. Select the gateway for which you want to delete the monitoring condition from the Gateway selector at the top of the page.
4. In the row for the monitoring condition that you want to delete, select Delete in the Actions menu.
5. Verify the security profile name associated with the monitoring condition and click Confirm to confirm the deletion.

REST

To delete a monitoring condition, make a DELETE request to the securityMonitoringConditions API.

curl "https://apigee.googleapis.com/v1/organizations/ APIGEE_ORG 
/securityMonitoringConditions/ CONDITION_ID 
?risk_assessment_type=API_HUB" \
  -X DELETE \
  -H "Authorization: Bearer $TOKEN"

Replace the following:

• APIGEE_ORG : Name of the Apigee organization provisioned in your Google Cloud project.
• CONDITION_ID : The ID of the monitoring condition. Obtain the condition ID by using List monitoring conditions .