Skip to content

Commit

Permalink
Merge pull request #532 from PaloAltoNetworks/cwp-apiref-darwin
Browse files Browse the repository at this point in the history
Updated the links to Darwin documents
  • Loading branch information
manukumar6 authored Oct 20, 2023
2 parents 7c39bff + 633b6d4 commit fb94e44
Show file tree
Hide file tree
Showing 15 changed files with 42 additions and 54 deletions.
14 changes: 7 additions & 7 deletions openapi-specs/code/Policies.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion products/compute/api/22-12/stable-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Where:
As a best practice, update your scripts to use the version-specific API endpoints to ensure that your implementation is fully supported.
For the version-specific APIs, you will have access to the API Reference and Release Notes documentation for changes or updates that may impact you.

When using the version-specific endpoints, you will need to update your automation scripts approximately once-a- year to stay in sync with the product [support lifecycle](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-compute/upgrade/support_lifecycle.html).
When using the version-specific endpoints, you will need to update your automation scripts approximately once a year to stay in sync with the product [Support lifecycle for connected components](https://docs.prismacloud.io/en/compute-edition/22-12/admin-guide/upgrade/support-lifecycle).

**Note**: If you have a mixed environment of different version Defenders, then use the version of the API that matches the earliest version.

Expand Down
2 changes: 1 addition & 1 deletion products/compute/api/30-00/stable-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Where:
As a best practice, update your scripts to use the version-specific API endpoints to ensure that your implementation is fully supported.
For the version-specific APIs, you will have access to the API Reference and Release Notes documentation for changes or updates that may impact you.

When using the version-specific endpoints, you will need to update your automation scripts approximately once-a- year to stay in sync with the product [support lifecycle](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-compute/upgrade/support_lifecycle.html).
When using the version-specific endpoints, you will need to update your automation scripts approximately once a year to stay in sync with the product [Support lifecycle for connected components](https://docs.prismacloud.io/en/compute-edition/30/admin-guide/upgrade/support-lifecycle).

Starting with version 30.xx, each maintenance release (like 30.01, 30.02, and so on) may contain new features and improvements. As a result, the URLs for the APIs will be updated to reflect the version.

Expand Down
2 changes: 1 addition & 1 deletion products/compute/api/30-01/stable-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Where:
As a best practice, update your scripts to use the version-specific API endpoints to ensure that your implementation is fully supported.
For the version-specific APIs, you will have access to the API Reference and Release Notes documentation for changes or updates that may impact you.

When using the version-specific endpoints, you will need to update your automation scripts approximately once-a- year to stay in sync with the product [support lifecycle](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-compute/upgrade/support_lifecycle.html).
When using the version-specific endpoints, you will need to update your automation scripts approximately once a year to stay in sync with the product [Support lifecycle for connected components](https://docs.prismacloud.io/en/compute-edition/30/admin-guide/upgrade/support-lifecycle).

Starting with version 30.xx, each maintenance release (like 30.01, 30.02, and so on) may contain new features and improvements. As a result, the URLs for the APIs will be updated to reflect the version.

Expand Down
2 changes: 1 addition & 1 deletion products/compute/api/30-02/stable-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Where:
As a best practice, update your scripts to use the version-specific API endpoints to ensure that your implementation is fully supported.
For the version-specific APIs, you will have access to the API Reference and Release Notes documentation for changes or updates that may impact you.

When using the version-specific endpoints, you will need to update your automation scripts approximately once-a- year to stay in sync with the product [support lifecycle](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-compute/upgrade/support_lifecycle.html).
When using the version-specific endpoints, you will need to update your automation scripts approximately once a year to stay in sync with the product [Support lifecycle for connected components](https://docs.prismacloud.io/en/compute-edition/30/admin-guide/upgrade/support-lifecycle).

Starting with version 30.xx, each maintenance release (like 30.01, 30.02, and so on) may contain new features and improvements. As a result, the URLs for the APIs will be updated to reflect the version.

Expand Down
2 changes: 1 addition & 1 deletion products/compute/api/30-03/stable-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Where:
As a best practice, update your scripts to use the version-specific API endpoints to ensure that your implementation is fully supported.
For the version-specific APIs, you will have access to the API Reference and Release Notes documentation for changes or updates that may impact you.

When using the version-specific endpoints, you will need to update your automation scripts approximately once-a- year to stay in sync with the product [support lifecycle](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-compute/upgrade/support_lifecycle.html).
When using the version-specific endpoints, you will need to update your automation scripts approximately once a year to stay in sync with the product [Support lifecycle for connected components](https://docs.prismacloud.io/en/compute-edition/30/admin-guide/upgrade/support-lifecycle).

Starting with version 30.xx, each maintenance release (like 30.01, 30.02, and so on) may contain new features and improvements. As a result, the URLs for the APIs will be updated to reflect the version.

Expand Down
2 changes: 1 addition & 1 deletion products/compute/api/31-00/stable-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Where:
As a best practice, update your scripts to use the version-specific API endpoints to ensure that your implementation is fully supported.
For the version-specific APIs, you will have access to the API Reference and Release Notes documentation for changes or updates that may impact you.

When using the version-specific endpoints, you will need to update your automation scripts approximately once-a- year to stay in sync with the product [support lifecycle](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-compute/upgrade/support_lifecycle.html).
When using the version-specific endpoints, you will need to update your automation scripts approximately once a year to stay in sync with the product [Support lifecycle for connected components](https://docs.prismacloud.io/en/compute-edition/31/admin-guide/upgrade/support-lifecycle).

Starting with version 30.xx, each maintenance release (like 30.01, 30.02, and so on) may contain new features and improvements. As a result, the URLs for the APIs will be updated to reflect the version.

Expand Down
2 changes: 1 addition & 1 deletion products/compute/api/stable-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Where:
As a best practice, update your scripts to use the version-specific API endpoints to ensure that your implementation is fully supported.
For the version-specific APIs, you will have access to the API Reference and Release Notes documentation for changes or updates that may impact you.

When using the version-specific endpoints, you will need to update your automation scripts approximately once-a- year to stay in sync with the product [support lifecycle](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-compute/upgrade/support_lifecycle.html).
When using the version-specific endpoints, you will need to update your automation scripts approximately once a year to stay in sync with the product [Support lifecycle for connected components](https://docs.prismacloud.io/en/classic/compute-admin-guide/upgrade/support-lifecycle). If you are upgraded to Darwin, see [Support Lifecycle for Connected Components](https://docs.prismacloud.io/en/enterprise-edition/content-collections/runtime-security/upgrade/support-lifecycle).

Starting with version 30.xx, each maintenance release (like 30.01, 30.02, and so on) may contain new features and improvements. As a result, the URLs for the APIs will be updated to reflect the version.

Expand Down
10 changes: 4 additions & 6 deletions products/prisma-cloud/api/code/basic-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,22 @@ keywords:

Use the following guidelines to ensure that your Application Security API requests to Prisma Cloud are successful.

See [Prisma Cloud Application Security](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-code-security.html) for more information and for directions to enable Application Security on Prisma Cloud.
For more information and for directions to enable Application Security on Prisma Cloud, see [Prisma Cloud Administrator’s Guide—Application Security](https://docs.prismacloud.io/en/classic/appsec-admin-guide). If you are upgraded to Darwin, see [Prisma Cloud Application Security](https://docs.prismacloud.io/en/enterprise-edition/content-collections/application-security/application-security).


## Prerequisites for a Application Security Request

To make a Application Security API request, you must have the right privileges and authorization for the request.

### Application Security Access

To have the right privileges to make a Application Security API request, you must set up:

- [Administrator access](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-code-security/get-started/setup-administrator-access.html)
- [Developer access](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-code-security/get-started/setup-developer-access.html)
To have the right privileges to make a Application Security API request, you must set up Administrator and Developer access. For more information, see - [Manage Roles and Permissions](https://docs.prismacloud.io/en/classic/cspm-admin-guide/manage-prisma-cloud-administrators/prisma-cloud-administrator-roles). If you are upgraded to Darwin, see [Administrator access](https://docs.prismacloud.io/en/classic/appsec-admin-guide/get-started/manage-roles-permissions).

### Application Security API Authorization

To have the right authorization for a Application Security API request, follow the high-level steps below:

1. [Obtain an access key](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin/manage-prisma-cloud-administrators/create-access-keys.html) from your Prisma Cloud system administrator.
1. [Create and Manage Access Keys](https://docs.prismacloud.io/en/classic/cspm-admin-guide/manage-prisma-cloud-administrators/create-access-keys). If you are upgraded to Darwin, see [Create and Manage Access Keys](https://docs.prismacloud.io/en/enterprise-edition/content-collections/administration/create-access-keys).
2. Make a CSPM API request to [log in](/prisma-cloud/api/cspm/app-login) . A successful request returns a JSON Web Token (JWT).

All the Application Security API requests use this JWT in the API request [header](/prisma-cloud/api/code/api-headers) for authorization. Note that for security, a JWT is valid for only ten minutes. If your session must be active beyond that limit, you can [extend a session](/prisma-cloud/api/cspm/extend-session/).
Expand Down
2 changes: 1 addition & 1 deletion products/prisma-cloud/api/code/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ enables you to:

Use the [CSPM Policy API](/prisma-cloud/api/cspm/policy) to create and manage Application Security build policies.

See [Prisma Cloud Application Security](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-code-security.html) for more information.
For more information, see [Prisma Cloud Administrator’s Guide—Application Security](https://docs.prismacloud.io/en/classic/appsec-admin-guide). If you are upgraded to Darwin, see [Prisma Cloud Application Security](https://docs.prismacloud.io/en/enterprise-edition/content-collections/application-security/application-security).

Check the status notifications at <https://status.paloaltonetworks.com/> for the Prisma Cloud release schedule to know when new functionality is available.
2 changes: 1 addition & 1 deletion products/prisma-cloud/api/cwpp/stable-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Where:
As a best practice, update your scripts to use the version-specific API endpoints to ensure that your implementation is fully supported.
For the version-specific APIs, you will have access to the API Reference and Release Notes documentation for changes or updates that may impact you.

When using the version-specific endpoints, you will need to update your automation scripts approximately once-a- year to stay in sync with the product [support lifecycle](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-compute/upgrade/support_lifecycle.html).
When using the version-specific endpoints, you will need to update your automation scripts approximately once a year to stay in sync with the product [Support lifecycle for connected components](https://docs.prismacloud.io/en/classic/compute-admin-guide/upgrade/support-lifecycle). If you are upgraded to Darwin, see [Support Lifecycle for Connected Components](https://docs.prismacloud.io/en/enterprise-edition/content-collections/runtime-security/upgrade/support-lifecycle).

**Note**: If you have a mixed environment of different version Defenders, then use the version of the API that matches the earliest version.

Expand Down
2 changes: 1 addition & 1 deletion products/prisma-cloud/docs/cwpp/view_registry_scan.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ After you configure, Prisma Cloud automatically scans images for vulnerabilities
3. Discovers the images using tags within each configured repository.
4. Scans the discovered images.

This guide shows how to get vulnerability report for container images stored in different registries. For more information about registry scan, see [Configure Registry Scan](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-compute/vulnerability_management/registry_scanning/configure_registry_scanning).
This guide shows how to get vulnerability report for container images stored in different registries. For more information about registry scan, see [Configure Registry Scan](https://docs.prismacloud.io/en/classic/compute-admin-guide/vulnerability-management/registry-scanning/configure-registry-scanning). If you are upgraded to Darwin, see [Configure Registry Scan](https://docs.prismacloud.io/en/enterprise-edition/content-collections/runtime-security/vulnerability-management/registry-scanning/configure-registry-scanning).


***Prerequisite***:
Expand Down
4 changes: 2 additions & 2 deletions products/prisma-cloud/docs/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ keywords:
- Cloud Workload Protection
---

Prisma™ Cloud is a cloud-native security platform that provides comprehensive visibility, threat detection/prevention, compliance assurance, and data protection across an organization’s hybrid, multi-cloud infrastructure. It is available as either an [Enterprise or Compute Edition](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-compute/welcome/pcee_vs_pcce.html), offering a convenient REST API for all three capabilities.
Prisma™ Cloud is a cloud-native security platform that provides comprehensive visibility, threat detection/prevention, compliance assurance, and data protection across an organization’s hybrid, multi-cloud infrastructure. It is available as either an Enterprise or Compute Edition, offering a convenient REST API for all three capabilities. For more information, see [Prisma Cloud Enterprise Edition vs Compute Edition](https://docs.prismacloud.io/en/classic/compute-admin-guide/welcome/pcee-vs-pcce). If you are upgraded to Darwin, see [Prisma Cloud Enterprise Edition vs Compute Edition](https://docs.prismacloud.io/en/enterprise-edition/content-collections/runtime-security/pcee-vs-pcce).

- [Cloud Security Posture Management](/prisma-cloud/api/cspm) enables you to configure custom integrations for your cloud security needs. For example, you can use it to automate sending alert notifications to your in-house tool or to extend the DevOps security capabilities for a tool that does not have an extension or plugin for Prisma Cloud. Most actions supported on the Prisma Cloud web interface are available with the REST API.

Expand All @@ -19,7 +19,7 @@ Prisma™ Cloud is a cloud-native security platform that provides comprehensive
- [Cloud Application Security](/prisma-cloud/api/code/) enables you to programmatically check your Infrastructure-as-Code resources against Prisma Cloud out-of-the-box and custom security policies, ensuring security throughout the build lifecycle.

For information about Prisma Cloud beyond its APIs, such as administration and policy management,
see the [Prisma Cloud administration documentation](https://docs.paloaltonetworks.com/prisma/prisma-cloud.html).
see the [Prisma Cloud documentation](https://docs.prismacloud.io/en).

:::info

Expand Down
4 changes: 2 additions & 2 deletions products/prisma-cloud/docs/twistcli_gs.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ Each package has the following name-value pairs:

## Running scans from inside the container

By default, `twistcli` is run from outside the container image. In some cases, you might need to copy `twistcli` to the container’s file system, and then run the scanner from inside the container. One reason you might want to run the scanner this way is when your build platform doesn’t give you access to the Docker socket. OpenShift Container Platform and CodeFresh are examples of such platforms. For step-by-step guidance on configuring the OpenShift build process, <a href="https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-compute/howto/openshift_build_twistcli_scanning.html" target="_blank">see here.</a>
By default, `twistcli` is run from outside the container image. In some cases, you might need to copy `twistcli` to the container’s file system, and then run the scanner from inside the container. One reason you might want to run the scanner this way is when your build platform doesn’t give you access to the Docker socket. OpenShift Container Platform and CodeFresh are examples of such platforms. For step-by-step guidance on configuring the OpenShift build process, see [Scan Images Built with Jenkins in an OpenShift Environment](https://docs.prismacloud.io/en/compute-edition/31/admin-guide/tools/twistcli-scan-images). If you are upgraded to Darwin, see [Scan Images Built with Jenkins in an OpenShift Environment](https://docs.prismacloud.io/en/enterprise-edition/content-collections/runtime-security/tools/twistcli-scan-images).

There are some shortcomings with this scanning from inside a container, so you should only use this approach when no other approach is viable. The shortcomings are:

Expand Down Expand Up @@ -440,7 +440,7 @@ $ twistcli hosts scan \

Where the `--skip-docker` option skips all Docker compliance checks such as the Docker daemon configuration and the `--include-3rd-party` option scans application-specific files such as Java JARs.

> A detailed procedure for setting up twistcli scanning during the OpenShift build process can be found <a href="https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin-compute/howto/openshift_build_twistcli_scanning.html" target="_blank">here</a>.
> For the detailed procedure for setting up twistcli scanning during the OpenShift build process, see [Scan Images Built with Jenkins in an OpenShift Environment](https://docs.prismacloud.io/en/compute-edition/31/admin-guide/tools/twistcli-scan-images). If you are upgraded to Darwin, see [Scan Images Built with Jenkins in an OpenShift Environment](https://docs.prismacloud.io/en/enterprise-edition/content-collections/runtime-security/tools/twistcli-scan-images).

## Scan images when the Docker socket isn’t in the default location

Expand Down
Loading

0 comments on commit fb94e44

Please sign in to comment.