Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FX-4898] Fix broken API docs links #557

Merged
merged 4 commits into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/en/Cobalt-API/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ The Cobalt [RESTful API](/getting-started/glossary/#restful-api) gives you acces

Here are some examples of how you can scale your workflows:

- Retrieve [findings](/cobalt-api/v2/#findings) that our pentesters discovered during a pentest.
- Retrieve [findings](/cobalt-api/documentation/v2/#findings) that our pentesters discovered during a pentest.
- Pull findings into your security dashboard to perform a holistic internal analysis.
- Integrate findings into your data visualization tool for a comprehensive view of your vulnerability and application landscape.

Read our comprehensive API documentation to learn how to send specific API requests and view examples.

<a href="/cobalt-api/v2" target="_blank" class="btn btn-outline-primary rounded">Go to API Docs »</a>
<a href="/cobalt-api/documentation/v2" target="_blank" class="btn btn-outline-primary rounded">Go to API Docs »</a>

## Authentication

Expand Down
12 changes: 6 additions & 6 deletions content/en/Cobalt-API/create_asset.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: >
---

{{% pageinfo %}}
Use this document with our [Cobalt API documentation](/cobalt-api/v2) to
Use this document with our [Cobalt API documentation](/cobalt-api/documentation/v2) to
define your assets on the Cobalt platform.
{{% /pageinfo %}}

Expand Down Expand Up @@ -50,7 +50,7 @@ curl -X POST "https://api.cobalt.io/assets" \
```

For more information on each parameter, see our API reference documentation on
how to [Create an Asset](/cobalt-api/v2/#create-an-asset).
how to [Create an Asset](/cobalt-api/documentation/v2/#create-an-asset).

The command we use includes a `-v`, which sets up output in verbose mode. The
command works without it. However, you would see no response from this REST call.
Expand All @@ -62,7 +62,7 @@ with `HTTP/2`. If the command is successful, you'll see
|------------|------------------|
| HTTP/2 201 | Asset created |

For a list of error codes, see the [Errors](/cobalt-api/v2/#errors)
For a list of error codes, see the [Errors](/cobalt-api/documentation/v2/#errors)
section of our API reference.

### Next Steps
Expand All @@ -76,7 +76,7 @@ then [Add or Modify Asset Details](#add-or-modify-asset-details).
## Find Your Asset ID

To add or modify information related to your asset, you'll need the asset ID.
You can find this ID with the REST call to [Get All Assets](/cobalt-api/v2/#get-all-assets):
You can find this ID with the REST call to [Get All Assets](/cobalt-api/documentation/v2/#get-all-assets):

```bash
curl -X GET "https://api.cobalt.io/assets" \
Expand All @@ -89,7 +89,7 @@ curl -X GET "https://api.cobalt.io/assets" \
If you've set up more than one asset, you may need to search through the output.
You can also limit the number of assets in the output with the `limit`
parameter. For more information about each asset response field, see our API
reference to [Get All Assets](/cobalt-api/v2/#get-all-assets).
reference to [Get All Assets](/cobalt-api/documentation/v2/#get-all-assets).

{{% alert title="Tip" color="primary" %}}
You can use `jq` to filter assets by their `title` and `id`. To do so, end the
Expand Down Expand Up @@ -152,7 +152,7 @@ with `HTTP/2`. If the command is successful, you'll see:
|------------|------------------|
| HTTP/2 204 | Asset updated |

For a list of error codes, see the [Errors](/cobalt-api/v2/#errors)
For a list of error codes, see the [Errors](/cobalt-api/documentation/v2/#errors)
section of our API reference.

<!-- Leaving out due to current bug, API-1069
Expand Down
6 changes: 3 additions & 3 deletions content/en/Cobalt-API/get-findings.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: >
---

{{% pageinfo %}}
Use this document with our [Cobalt API documentation](/cobalt-api/v2) to retrieve Cobalt findings for all pentests.
Use this document with our [Cobalt API documentation](/cobalt-api/documentation/v2) to retrieve Cobalt findings for all pentests.
{{% /pageinfo %}}

Complete the following steps:
Expand Down Expand Up @@ -123,15 +123,15 @@ You should see output similar to:
</br>

For more information on each parameter, see our API reference documentation on
how to [get all findings](/cobalt-api/v2/#get-all-findings).
how to [get all findings](/cobalt-api/documentation/v2/#get-all-findings).

If the command is successful, you'll see the following HTTP code:

| Message | Meaning |
|------------|------------------|
| 200 OK | Findings for all pentests of an organization are returned. |

For a list of error codes, see the [Errors](/cobalt-api/v2/#errors)
For a list of error codes, see the [Errors](/cobalt-api/documentation/v2/#errors)
section of our API reference.

## Step 2: Import Findings to Google Sheets
Expand Down
2 changes: 1 addition & 1 deletion content/en/Cobalt-API/get-organization-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ Include the organization token in the `X-Org-Token` header of your requests.
-H "X-Org-Token: YOUR-V2-ORGANIZATION-TOKEN"
```

For more information, see our API reference documentation on the [organizations](/cobalt-api/v2/#organizations) endpoint.
For more information, see our API reference documentation on the [organizations](/cobalt-api/documentation/v2/#organizations) endpoint.
2 changes: 1 addition & 1 deletion content/en/Getting started/Assets/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,6 @@ The **Asset** screen prompts you for the following information:
- Assign internal teams or business units to manage specific assets in Cobalt.
- Assign a compliance audit type the asset is subject to, such as `SOC 2`, `PCI-DSS`, or `CREST`.

You can also add asset tags using the Cobalt API. Learn more in our [API documentation](/cobalt-api/v2/#assets).
You can also add asset tags using the Cobalt API. Learn more in our [API documentation](/cobalt-api/documentation/v2/#assets).

![Add custom tags to Cobalt assets](/gsg/asset-tags.png "Add custom tags to Cobalt assets")
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Here's an example of what these steps look like in a recipe:
{{% image src="/integrations/integration_builder/how_to_guides/external_ticket_references/search_ticket_reference.png" alt="Search ticket reference" %}}
{{% image src="/integrations/integration_builder/how_to_guides/external_ticket_references/create_ticket_reference.png" alt="Create ticket reference" %}}

See [our public API documentation](/cobalt-api/v2/) for more information about the properties of an external ticket reference.
See [our public API documentation](/cobalt-api/documentation/v2) for more information about the properties of an external ticket reference.

## Customizing fields

Expand Down
2 changes: 1 addition & 1 deletion content/en/Integrations/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Learn more about [these integrations](/integrations/beta/).

Use our API to build your own integrations. You need a personal Cobalt [API token](/cobalt-api/create-personal-api-token/) to make REST calls.

Refer to the [API documentation](/cobalt-api/v2) for details.
Refer to the [API documentation](/cobalt-api/documentation/v2) for details.

## Suggest an Integration

Expand Down
6 changes: 3 additions & 3 deletions content/en/Integrations/defectdojo.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ You can retrieve [findings](/platform-deep-dive/pentests/findings/) data from Co
To configure the integration, you need the following:

- **Cobalt API token**. Learn [how to create an API token](/cobalt-api/create-personal-api-token/).
- **Cobalt organization token**. Learn [how to retrieve an organization token](https://docs.cobalt.io/cobalt-api/v1/#organizations) using the Cobalt API v1.
- Make sure that you use the [Cobalt API v1](https://docs.cobalt.io/cobalt-api/v1) and not v2. This integration doesn't support organization tokens from the API v2.
- **Cobalt organization token**. Learn [how to retrieve an organization token](/cobalt-api/documentation/v1/#organizations) using the Cobalt API v1.
- Make sure that you use the [Cobalt API v1](/cobalt-api/documentation/v1) and not v2. This integration doesn't support organization tokens from the API v2.
- **Asset identifier in Cobalt**. You can get an asset ID in two ways:
- In the Cobalt app, go to **Assets**, navigate to the asset page, and copy the ID from the URL. For example, the asset ID in this example URL `https://app.cobalt.io/organization/assets/as_KoEUfS0` is `as_KoEUfS0`.
- [Retrieve your assets](https://docs.cobalt.io/cobalt-api/v1/#assets) using the Cobalt API, and find the asset ID in the API response.
- [Retrieve your assets](/cobalt-api/documentation/v1/#assets) using the Cobalt API, and find the asset ID in the API response.

## Step 1: Add a Tool Type

Expand Down
4 changes: 2 additions & 2 deletions content/en/Integrations/kenna-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ You can retrieve [findings](/platform-deep-dive/pentests/findings/) data from Co
To configure the integration, you need the following:

- **Cobalt API token**. Learn [how to create an API token](/cobalt-api/create-personal-api-token/).
- **Cobalt organization token**. Learn [how to retrieve an organization token](https://docs.cobalt.io/cobalt-api/v1/#organizations) using the Cobalt API v1.
- Make sure that you use the [Cobalt API v1](https://docs.cobalt.io/cobalt-api/v1) and not v2. This integration doesn't support organization tokens from the API v2.
- **Cobalt organization token**. Learn [how to retrieve an organization token](/cobalt-api/documentation/v1/#organizations) using the Cobalt API v1.
- Make sure that you use the [Cobalt API v1](/cobalt-api/documentation/v1) and not v2. This integration doesn't support organization tokens from the API v2.
- **Kenna Security API key**. Learn [how to create an API key](https://help.kennasecurity.com/hc/en-us/articles/360029111331-API-Key-Generation-and-Permissions).
- **Kenna Security connector ID**. Create a Kenna Security Data Importer connector, and copy the connector ID as described in [step 1](#step-1-create-a-kenna-security-data-importer-connector).

Expand Down
6 changes: 3 additions & 3 deletions content/en/Integrations/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ sequenceDiagram
{{< /mermaid >}}
<br>

You can configure webhooks through the [API](/cobalt-api/v2/#webhooks) and in the [Cobalt UI](#configure-webhooks-in-the-ui).
You can configure webhooks through the [API](/#webhooks) and in the [Cobalt UI](#configure-webhooks-in-the-ui).
<!-- Provide a link to API docs or API use case. -->

## Before You Start
Expand All @@ -40,7 +40,7 @@ Before you start creating webhooks, complete the configuration in your app.
1. Make sure that the **URL** where you want to receive notifications is valid and your services work properly. If possible, test your connections.
1. (Optional) To add an extra layer of security to the integration, generate a **webhook secret** in your app. When we send a POST request to your URL, we include your secret in the request header. This allows you to validate that the API request is from Cobalt.

Read our [Best Practices](/cobalt-api/v2/#best-practices) for more information.
Read our [Best Practices](/cobalt-api/documentation/v2/#best-practices) for more information.

## Webhook Events

Expand All @@ -50,7 +50,7 @@ When you set up a webhook, you can **select events** to which you want to subscr
|---|---|
| <li>Pentest created</li><li>[Pentest state](/platform-deep-dive/pentests/pentest-process/pentest-states/) updated</li> | <li>Finding deleted</li><li>Finding published</li><li>[Finding state](/platform-deep-dive/pentests/findings/finding-states/) updated</li><li>Finding updated</li>

For security reasons, we only post essential details about webhook events, such as their ID and type. To retrieve more information about the event, use the [Cobalt API](/cobalt-api/v2).
For security reasons, we only post essential details about webhook events, such as their ID and type. To retrieve more information about the event, use the [Cobalt API](/cobalt-api/documentation/v2).

{{% alert title="Note" color="primary" %}}
For webhooks that you created before June 2023, you get updates for **all events**. You can adjust the configuration of your existing webhooks. Select the three-dot icon {{% three-dots %}} under **Actions**, select **Edit Webhook**, select webhook events in the overlay, and then select **Save** to confirm.
Expand Down
2 changes: 1 addition & 1 deletion content/en/PMP/manage-pentests.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ To launch an In-House Pentest:
Once the pentest goes Live, pentesters can start testing your asset. You can track the progress in real time.

{{< alert title="Note" color="primary" >}}
You can enable [integrations](/integrations/), configure [webhooks](/integrations/webhooks/), and use the [Cobalt API](/cobalt-api/v2) for your In-House Pentests.
You can enable [integrations](/integrations/), configure [webhooks](/integrations/webhooks/), and use the [Cobalt API](/cobalt-api/documentation/v2) for your In-House Pentests.
{{< /alert >}}

## Collaborate on the Pentest
Expand Down
2 changes: 1 addition & 1 deletion content/en/Platform Deep Dive/Credits/ptaas-tiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The availability of some features in the Cobalt platform depends on the {{% ptaa
| Best practice methodology and coverage checklist | ✓ | ✓ | ✓ | Our pentesters use [pentest methodologies](/methodologies/) that are recognized as best practices in the security industry. They follow a coverage checklist based on [OWASP](https://owasp.org/) standards to test your assets. |
| Detailed findings with recommended fixes | ✓ | ✓ | ✓ | When our pentesters find a [vulnerability](/getting-started/glossary/#vulnerability) in your [asset](/getting-started/glossary/#asset) during a pentest, they submit [findings](/getting-started/glossary/#finding) and provide recommendations on how to fix them. |
| Real-time collaboration via Slack and the platform | ✓ | ✓ | ✓ | You get real-time updates from pentesters as they're testing your asset—in a dedicated Slack channel and in the Cobalt platform. You can promptly follow up on the issues they reported. |
| Cobalt API | ✓ | ✓ | ✓ | Use the [Cobalt RESTful API](/cobalt-api/v2) to integrate pentest data into your development and application security tools. Build your own integrations to streamline your workflows. |
| Cobalt API | ✓ | ✓ | ✓ | Use the [Cobalt RESTful API](/cobalt-api/documentation/v2) to integrate pentest data into your development and application security tools. Build your own integrations to streamline your workflows. |
| Groups | ✓ | ✓ | ✓ | An Organization Owner can create [groups](/platform-deep-dive/collaboration/groups) and manage access to assets, pentests, and findings. |
| Start pentest within | 3 business days | 2 business days | 1 business day | The pentest start time is based on your PtaaS tier and depends on when you've submitted all the required information for your pentest. We move the pentest to [Planned](/penteststates/), allocate pentesters—and they start testing your asset within the following timeframes:<ul><li>Standard tier: 3 business days</li><li>Premium tier: 2 business days</li><li>Enterprise tier: 1 business day</li></ul> |
| Free retesting duration | 6 months | 12 months | 12 months | [Free retesting duration](/platform-deep-dive/pentests/findings/remediate-findings/#free-retesting-duration) for your pentest [findings](/platform-deep-dive/pentests/findings/) depends on your PtaaS tier:<ul><li>Standard tier: 6 months</li><li>Premium and Enterprise tiers: 12 months</li></ul>The timeline for retesting starts after your pentest end date within an active contract. Mark your findings as Ready for Retest at least 10 days before your contract ends. |
Expand Down
8 changes: 4 additions & 4 deletions content/en/Platform Deep Dive/Organization/your-contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ To renew your contract, reach out to your Customer Success Manager or support@co

To export pentest data for your organization, you can:

- Use the Cobalt API. Read our [API documentation](/cobalt-api/v2) for details. You can send API requests to retrieve pentest data, such as:
- [All pentests](/cobalt-api/v2/#get-all-pentests)
- [All findings](/cobalt-api/v2/#get-all-findings)
- [A pentest report](/cobalt-api/v2/#get-a-pentest-report)
- Use the Cobalt API. Read our [API documentation](/cobalt-api/documentation/v2) for details. You can send API requests to retrieve pentest data, such as:
- [All pentests](/cobalt-api/documentation/v2/#get-all-pentests)
- [All findings](/cobalt-api/documentation/v2/#get-all-findings)
- [A pentest report](/cobalt-api/documentation/v2/#get-a-pentest-report)
- Manually download [findings](/platform-deep-dive/pentests/findings/) and [reports](/platform-deep-dive/pentests/reports/) for each pentest in the Cobalt app. Select the <i style="font-size:x-large; color: #0047AB" class="fas fa-chevron-right"></i> key for instructions.
{{%expand "To download all findings for a pentest:" %}}
1. On the pentest page, navigate to the **Findings** tab.
Expand Down
2 changes: 1 addition & 1 deletion content/en/Platform Deep Dive/Pentests/Findings/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: >
Once your pentest goes [Live](/platform-deep-dive/pentests/pentest-process/pentest-states/), pentesters start testing your [asset](/platform-deep-dive/assets/). You get updates from pentesters in a dedicated Slack channel and in the **Pentester Updates** sidebar.

{{< alert title="Note" color="primary" >}}
You can manage findings using the Cobalt API. Learn more in our [API documentation](/cobalt-api/v2/#findings).
You can manage findings using the Cobalt API. Learn more in our [API documentation](/cobalt-api/documentation/v2/#findings).
{{< /alert >}}

## Organization View
Expand Down
2 changes: 1 addition & 1 deletion hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ time_format_blog = "02.01.2006"
weight = 30
[[menu.main]]
name = 'API Docs'
url = 'https://docs.cobalt.io/cobalt-api/v2'
url = 'https://docs.cobalt.io/cobalt-api/documentation/v2'
weight = 40

# Everything below this are Site Params
Expand Down
4 changes: 2 additions & 2 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ NODE_VERSION = "20.17.0"
# Redirects for the old docs.cobalt.io API documentation to the new location
[[redirects]]
from = "/v1"
to = "/cobalt-api/v1"
to = "/cobalt-api/documentation/v1"
status = 301
[[redirects]]
from = "/v2"
to = "/cobalt-api/v2"
to = "/cobalt-api/documentation/v2"
status = 301