Improves IA of the API ref section (#14523)

Co-authored-by: Bill Palombi <[email protected]>
PrefectHQ · Jul 10, 2024 · abc6d04 · abc6d04
1 parent 954d250
commit abc6d04
Show file tree

Hide file tree

Showing 186 changed files with 378 additions and 421 deletions.
diff --git a/docs/3.0rc/api-ref/index.mdx b/docs/3.0rc/api-ref/index.mdx
@@ -1,14 +1,12 @@
 ---
-title: API Reference
-description: Explore Prefect's auto-generated reference documentation.
+title: API & SDK References
+sidebarTitle: Overview
+description: Explore Prefect's auto-generated API & SDK reference documentation.
 ---
 
 Prefect auto-generates reference documentation for the following components:
 
 - **[Prefect Python SDK](https://prefect-python-sdk-docs.netlify.app/)**: used to build, test, and execute workflows.
-- **Prefect REST API**: used by workflow clients and the Prefect UI for orchestration and data retrieval.
-  - Prefect Cloud REST API documentation is available at <a href="https://app.prefect.cloud/api/docs" target="_blank">https://app.prefect.cloud/api/docs</a>.
-  - The REST API documentation for self-hosted Prefect server is available in the [Prefect REST API Reference](3.0rc/api-ref/server).
-
-
-When self-hosting, you can access REST API documentation at the `/docs` endpoint of your [`PREFECT_API_URL`](/3.0rc/manage/settings-and-profiles/) - for example, if you ran `prefect server start` with no additional configuration you can find this reference at <a href="http://localhost:4200/docs" target="_blank">http://localhost:4200/docs</a>.
+- **[Prefect REST API](/3.0rc/api-ref/)**: used by workflow clients and the Prefect UI for orchestration and data retrieval.
+  - Prefect Cloud REST API documentation: <a href="https://app.prefect.cloud/api/docs" target="_blank">https://app.prefect.cloud/api/docs</a>.
+  - Self-hosted Prefect server [REST API documentation](/3.0rc/api-ref/server). Additionally, if self-hosting a Prefect server instance, you can access REST API documentation at the `/docs` endpoint of your [`PREFECT_API_URL`](/3.0rc/manage/settings-and-profiles/). For example, if you run `prefect server start` with no additional configuration you can find this reference at <a href="http://localhost:4200/docs" target="_blank">http://localhost:4200/docs</a>.
diff --git a/docs/3.0rc/api-ref/rest-api/cloud-rest-api-reference.mdx b/docs/3.0rc/api-ref/rest-api/cloud-rest-api-reference.mdx
diff --git a/docs/3.0rc/api-ref/rest-api/cloud/index.mdx b/docs/3.0rc/api-ref/rest-api/cloud/index.mdx
@@ -0,0 +1,8 @@
+---
+title: Cloud API Overview
+description: The Prefect Cloud API enables you to interact programmatically with Prefect Cloud.
+---
+
+The Prefect Cloud API is organized around REST. 
+
+Explore the interactive [Prefect Cloud REST API reference](https://app.prefect.cloud/api/docs).
diff --git a/docs/3.0rc/api-ref/rest-api/index.mdx b/docs/3.0rc/api-ref/rest-api/index.mdx
@@ -1,6 +1,6 @@
 ---
-title: Cloud API Overview
-description: Prefect REST API for interacting with the orchestration engine and Prefect Cloud.
+title: REST API overview
+description: Prefect REST API for interacting with Prefect Cloud & self-hosted Prefect server.
 ---
 
 The Prefect API is organized around REST. It is used for communicating data from clients to a self-hosted Prefect server instance so that orchestration can be performed. This API is consumed by clients such as the Prefect Python SDK or the server dashboard.
@@ -17,7 +17,7 @@ Prefect Cloud and self-hosted Prefect server each provide a REST API.
 
 You can interact with the Prefect REST API in several ways:
 
-- Create an instance of [`PrefectClient`](https://prefect-python-sdk-docs.netlify.app/prefect/client/orchestration/#prefect.client.orchestration.PrefectClient) 
+- Create an instance of [`PrefectClient`](https://prefect-python-sdk-docs.netlify.app/prefect/client/orchestration/#prefect.client.orchestration.PrefectClient), which is part of the [Prefect Python SDK](/3.0rc/api-ref/python/).
 - Use your favorite Python HTTP library such as [Requests](https://requests.readthedocs.io/en/latest/) or [HTTPX](https://www.python-httpx.org/)
 - Use an HTTP library in your language of choice
 - Use [curl](https://curl.se/) from the command line 

diff --git a/...c/api-ref/server/admin/clear-database.mdx → .../rest-api/server/admin/clear-database.mdx b/...c/api-ref/server/admin/clear-database.mdx → .../rest-api/server/admin/clear-database.mdx
diff --git a/.../api-ref/server/admin/create-database.mdx → ...rest-api/server/admin/create-database.mdx b/.../api-ref/server/admin/create-database.mdx → ...rest-api/server/admin/create-database.mdx
diff --git a/...rc/api-ref/server/admin/drop-database.mdx → ...f/rest-api/server/admin/drop-database.mdx b/...rc/api-ref/server/admin/drop-database.mdx → ...f/rest-api/server/admin/drop-database.mdx
diff --git a/...rc/api-ref/server/admin/read-settings.mdx → ...f/rest-api/server/admin/read-settings.mdx b/...rc/api-ref/server/admin/read-settings.mdx → ...f/rest-api/server/admin/read-settings.mdx
diff --git a/...0rc/api-ref/server/admin/read-version.mdx → ...ef/rest-api/server/admin/read-version.mdx b/...0rc/api-ref/server/admin/read-version.mdx → ...ef/rest-api/server/admin/read-version.mdx
diff --git a/...-ref/server/artifacts/count-artifacts.mdx → ...-api/server/artifacts/count-artifacts.mdx b/...-ref/server/artifacts/count-artifacts.mdx → ...-api/server/artifacts/count-artifacts.mdx
diff --git a/...rver/artifacts/count-latest-artifacts.mdx → ...rver/artifacts/count-latest-artifacts.mdx b/...rver/artifacts/count-latest-artifacts.mdx → ...rver/artifacts/count-latest-artifacts.mdx
diff --git a/...-ref/server/artifacts/create-artifact.mdx → ...-api/server/artifacts/create-artifact.mdx b/...-ref/server/artifacts/create-artifact.mdx → ...-api/server/artifacts/create-artifact.mdx
diff --git a/...-ref/server/artifacts/delete-artifact.mdx → ...-api/server/artifacts/delete-artifact.mdx b/...-ref/server/artifacts/delete-artifact.mdx → ...-api/server/artifacts/delete-artifact.mdx
diff --git a/...pi-ref/server/artifacts/read-artifact.mdx → ...st-api/server/artifacts/read-artifact.mdx b/...pi-ref/server/artifacts/read-artifact.mdx → ...st-api/server/artifacts/read-artifact.mdx
diff --git a/...i-ref/server/artifacts/read-artifacts.mdx → ...t-api/server/artifacts/read-artifacts.mdx b/...i-ref/server/artifacts/read-artifacts.mdx → ...t-api/server/artifacts/read-artifacts.mdx
diff --git a/...server/artifacts/read-latest-artifact.mdx → ...server/artifacts/read-latest-artifact.mdx b/...server/artifacts/read-latest-artifact.mdx → ...server/artifacts/read-latest-artifact.mdx
diff --git a/...erver/artifacts/read-latest-artifacts.mdx → ...erver/artifacts/read-latest-artifacts.mdx b/...erver/artifacts/read-latest-artifacts.mdx → ...erver/artifacts/read-latest-artifacts.mdx
diff --git a/...-ref/server/artifacts/update-artifact.mdx → ...-api/server/artifacts/update-artifact.mdx b/...-ref/server/artifacts/update-artifact.mdx → ...-api/server/artifacts/update-artifact.mdx
diff --git a/.../server/automations/count-automations.mdx → .../server/automations/count-automations.mdx b/.../server/automations/count-automations.mdx → .../server/automations/count-automations.mdx
diff --git a/.../server/automations/create-automation.mdx → .../server/automations/create-automation.mdx b/.../server/automations/create-automation.mdx → .../server/automations/create-automation.mdx
diff --git a/.../server/automations/delete-automation.mdx → .../server/automations/delete-automation.mdx b/.../server/automations/delete-automation.mdx → .../server/automations/delete-automation.mdx
diff --git a/.../delete-automations-owned-by-resource.mdx → .../delete-automations-owned-by-resource.mdx b/.../delete-automations-owned-by-resource.mdx → .../delete-automations-owned-by-resource.mdx
diff --git a/...f/server/automations/patch-automation.mdx → ...i/server/automations/patch-automation.mdx b/...f/server/automations/patch-automation.mdx → ...i/server/automations/patch-automation.mdx
diff --git a/...ef/server/automations/read-automation.mdx → ...pi/server/automations/read-automation.mdx b/...ef/server/automations/read-automation.mdx → ...pi/server/automations/read-automation.mdx
diff --git a/.../read-automations-related-to-resource.mdx → .../read-automations-related-to-resource.mdx b/.../read-automations-related-to-resource.mdx → .../read-automations-related-to-resource.mdx
diff --git a/...f/server/automations/read-automations.mdx → ...i/server/automations/read-automations.mdx b/...f/server/automations/read-automations.mdx → ...i/server/automations/read-automations.mdx
diff --git a/.../server/automations/update-automation.mdx → .../server/automations/update-automation.mdx b/.../server/automations/update-automation.mdx → .../server/automations/update-automation.mdx
diff --git a/.../server/automations/validate-template.mdx → .../server/automations/validate-template.mdx b/.../server/automations/validate-template.mdx → .../server/automations/validate-template.mdx
diff --git a/...ies/read-available-block-capabilities.mdx → ...ies/read-available-block-capabilities.mdx b/...ies/read-available-block-capabilities.mdx → ...ies/read-available-block-capabilities.mdx
diff --git a/...block-documents/count-block-documents.mdx → ...block-documents/count-block-documents.mdx b/...block-documents/count-block-documents.mdx → ...block-documents/count-block-documents.mdx
diff --git a/...block-documents/create-block-document.mdx → ...block-documents/create-block-document.mdx b/...block-documents/create-block-document.mdx → ...block-documents/create-block-document.mdx
diff --git a/...block-documents/delete-block-document.mdx → ...block-documents/delete-block-document.mdx b/...block-documents/delete-block-document.mdx → ...block-documents/delete-block-document.mdx
diff --git a/...k-documents/read-block-document-by-id.mdx → ...k-documents/read-block-document-by-id.mdx b/...k-documents/read-block-document-by-id.mdx → ...k-documents/read-block-document-by-id.mdx
diff --git a/.../block-documents/read-block-documents.mdx → .../block-documents/read-block-documents.mdx b/.../block-documents/read-block-documents.mdx → .../block-documents/read-block-documents.mdx
diff --git a/...-documents/update-block-document-data.mdx → ...-documents/update-block-document-data.mdx b/...-documents/update-block-document-data.mdx → ...-documents/update-block-document-data.mdx
diff --git a/...ver/block-schemas/create-block-schema.mdx → ...ver/block-schemas/create-block-schema.mdx b/...ver/block-schemas/create-block-schema.mdx → ...ver/block-schemas/create-block-schema.mdx
diff --git a/...ver/block-schemas/delete-block-schema.mdx → ...ver/block-schemas/delete-block-schema.mdx b/...ver/block-schemas/delete-block-schema.mdx → ...ver/block-schemas/delete-block-schema.mdx
diff --git a/...schemas/read-block-schema-by-checksum.mdx → ...schemas/read-block-schema-by-checksum.mdx b/...schemas/read-block-schema-by-checksum.mdx → ...schemas/read-block-schema-by-checksum.mdx
diff --git a/...block-schemas/read-block-schema-by-id.mdx → ...block-schemas/read-block-schema-by-id.mdx b/...block-schemas/read-block-schema-by-id.mdx → ...block-schemas/read-block-schema-by-id.mdx
diff --git a/...rver/block-schemas/read-block-schemas.mdx → ...rver/block-schemas/read-block-schemas.mdx b/...rver/block-schemas/read-block-schemas.mdx → ...rver/block-schemas/read-block-schemas.mdx
diff --git a/.../server/block-types/create-block-type.mdx → .../server/block-types/create-block-type.mdx b/.../server/block-types/create-block-type.mdx → .../server/block-types/create-block-type.mdx
diff --git a/.../server/block-types/delete-block-type.mdx → .../server/block-types/delete-block-type.mdx b/.../server/block-types/delete-block-type.mdx → .../server/block-types/delete-block-type.mdx
diff --git a/...lock-types/install-system-block-types.mdx → ...lock-types/install-system-block-types.mdx b/...lock-types/install-system-block-types.mdx → ...lock-types/install-system-block-types.mdx
diff --git a/...block-document-by-name-for-block-type.mdx → ...block-document-by-name-for-block-type.mdx b/...block-document-by-name-for-block-type.mdx → ...block-document-by-name-for-block-type.mdx
diff --git a/...s/read-block-documents-for-block-type.mdx → ...s/read-block-documents-for-block-type.mdx b/...s/read-block-documents-for-block-type.mdx → ...s/read-block-documents-for-block-type.mdx
diff --git a/...ver/block-types/read-block-type-by-id.mdx → ...ver/block-types/read-block-type-by-id.mdx b/...ver/block-types/read-block-type-by-id.mdx → ...ver/block-types/read-block-type-by-id.mdx
diff --git a/...r/block-types/read-block-type-by-slug.mdx → ...r/block-types/read-block-type-by-slug.mdx b/...r/block-types/read-block-type-by-slug.mdx → ...r/block-types/read-block-type-by-slug.mdx
diff --git a/...f/server/block-types/read-block-types.mdx → ...i/server/block-types/read-block-types.mdx b/...f/server/block-types/read-block-types.mdx → ...i/server/block-types/read-block-types.mdx
diff --git a/.../server/block-types/update-block-type.mdx → .../server/block-types/update-block-type.mdx b/.../server/block-types/update-block-type.mdx → .../server/block-types/update-block-type.mdx
diff --git a/.../server/collections/read-view-content.mdx → .../server/collections/read-view-content.mdx b/.../server/collections/read-view-content.mdx → .../server/collections/read-view-content.mdx
diff --git a/...limits-v2/bulk-decrement-active-slots.mdx → ...limits-v2/bulk-decrement-active-slots.mdx b/...limits-v2/bulk-decrement-active-slots.mdx → ...limits-v2/bulk-decrement-active-slots.mdx
diff --git a/...limits-v2/bulk-increment-active-slots.mdx → ...limits-v2/bulk-increment-active-slots.mdx b/...limits-v2/bulk-increment-active-slots.mdx → ...limits-v2/bulk-increment-active-slots.mdx
diff --git a/...limits-v2/create-concurrency-limit-v2.mdx → ...limits-v2/create-concurrency-limit-v2.mdx b/...limits-v2/create-concurrency-limit-v2.mdx → ...limits-v2/create-concurrency-limit-v2.mdx
diff --git a/...limits-v2/delete-concurrency-limit-v2.mdx → ...limits-v2/delete-concurrency-limit-v2.mdx b/...limits-v2/delete-concurrency-limit-v2.mdx → ...limits-v2/delete-concurrency-limit-v2.mdx
diff --git a/...its-v2/read-all-concurrency-limits-v2.mdx → ...its-v2/read-all-concurrency-limits-v2.mdx b/...its-v2/read-all-concurrency-limits-v2.mdx → ...its-v2/read-all-concurrency-limits-v2.mdx
diff --git a/...y-limits-v2/read-concurrency-limit-v2.mdx → ...y-limits-v2/read-concurrency-limit-v2.mdx b/...y-limits-v2/read-concurrency-limit-v2.mdx → ...y-limits-v2/read-concurrency-limit-v2.mdx
diff --git a/...limits-v2/update-concurrency-limit-v2.mdx → ...limits-v2/update-concurrency-limit-v2.mdx b/...limits-v2/update-concurrency-limit-v2.mdx → ...limits-v2/update-concurrency-limit-v2.mdx
diff --git a/...rency-limits/create-concurrency-limit.mdx → ...rency-limits/create-concurrency-limit.mdx b/...rency-limits/create-concurrency-limit.mdx → ...rency-limits/create-concurrency-limit.mdx
diff --git a/...imits/delete-concurrency-limit-by-tag.mdx → ...imits/delete-concurrency-limit-by-tag.mdx b/...imits/delete-concurrency-limit-by-tag.mdx → ...imits/delete-concurrency-limit-by-tag.mdx
diff --git a/...rency-limits/delete-concurrency-limit.mdx → ...rency-limits/delete-concurrency-limit.mdx b/...rency-limits/delete-concurrency-limit.mdx → ...rency-limits/delete-concurrency-limit.mdx
diff --git a/...-limits/read-concurrency-limit-by-tag.mdx → ...-limits/read-concurrency-limit-by-tag.mdx b/...-limits/read-concurrency-limit-by-tag.mdx → ...-limits/read-concurrency-limit-by-tag.mdx
diff --git a/...urrency-limits/read-concurrency-limit.mdx → ...urrency-limits/read-concurrency-limit.mdx b/...urrency-limits/read-concurrency-limit.mdx → ...urrency-limits/read-concurrency-limit.mdx
diff --git a/...rrency-limits/read-concurrency-limits.mdx → ...rrency-limits/read-concurrency-limits.mdx b/...rrency-limits/read-concurrency-limits.mdx → ...rrency-limits/read-concurrency-limits.mdx
diff --git a/...limits/reset-concurrency-limit-by-tag.mdx → ...limits/reset-concurrency-limit-by-tag.mdx b/...limits/reset-concurrency-limit-by-tag.mdx → ...limits/reset-concurrency-limit-by-tag.mdx
diff --git a/....0rc/api-ref/server/create-csrf-token.mdx → ...ref/rest-api/server/create-csrf-token.mdx b/....0rc/api-ref/server/create-csrf-token.mdx → ...ref/rest-api/server/create-csrf-token.mdx
diff --git a/.../server/deployments/count-deployments.mdx → .../server/deployments/count-deployments.mdx b/.../server/deployments/count-deployments.mdx → .../server/deployments/count-deployments.mdx
diff --git a/...ployments/create-deployment-schedules.mdx → ...ployments/create-deployment-schedules.mdx b/...ployments/create-deployment-schedules.mdx → ...ployments/create-deployment-schedules.mdx
diff --git a/.../server/deployments/create-deployment.mdx → .../server/deployments/create-deployment.mdx b/.../server/deployments/create-deployment.mdx → .../server/deployments/create-deployment.mdx
diff --git a/...ments/create-flow-run-from-deployment.mdx → ...ments/create-flow-run-from-deployment.mdx b/...ments/create-flow-run-from-deployment.mdx → ...ments/create-flow-run-from-deployment.mdx
diff --git a/...eployments/delete-deployment-schedule.mdx → ...eployments/delete-deployment-schedule.mdx b/...eployments/delete-deployment-schedule.mdx → ...eployments/delete-deployment-schedule.mdx
diff --git a/.../server/deployments/delete-deployment.mdx → .../server/deployments/delete-deployment.mdx b/.../server/deployments/delete-deployment.mdx → .../server/deployments/delete-deployment.mdx
diff --git a/...t-scheduled-flow-runs-for-deployments.mdx → ...t-scheduled-flow-runs-for-deployments.mdx b/...t-scheduled-flow-runs-for-deployments.mdx → ...t-scheduled-flow-runs-for-deployments.mdx
diff --git a/...rver/deployments/paginate-deployments.mdx → ...rver/deployments/paginate-deployments.mdx b/...rver/deployments/paginate-deployments.mdx → ...rver/deployments/paginate-deployments.mdx
diff --git a/...server/deployments/pause-deployment-1.mdx → ...server/deployments/pause-deployment-1.mdx b/...server/deployments/pause-deployment-1.mdx → ...server/deployments/pause-deployment-1.mdx
diff --git a/...f/server/deployments/pause-deployment.mdx → ...i/server/deployments/pause-deployment.mdx b/...f/server/deployments/pause-deployment.mdx → ...i/server/deployments/pause-deployment.mdx
diff --git a/...r/deployments/read-deployment-by-name.mdx → ...r/deployments/read-deployment-by-name.mdx b/...r/deployments/read-deployment-by-name.mdx → ...r/deployments/read-deployment-by-name.mdx
diff --git a/...deployments/read-deployment-schedules.mdx → ...deployments/read-deployment-schedules.mdx b/...deployments/read-deployment-schedules.mdx → ...deployments/read-deployment-schedules.mdx
diff --git a/...ef/server/deployments/read-deployment.mdx → ...pi/server/deployments/read-deployment.mdx b/...ef/server/deployments/read-deployment.mdx → ...pi/server/deployments/read-deployment.mdx
diff --git a/...f/server/deployments/read-deployments.mdx → ...i/server/deployments/read-deployments.mdx b/...f/server/deployments/read-deployments.mdx → ...i/server/deployments/read-deployments.mdx
diff --git a/...erver/deployments/resume-deployment-1.mdx → ...erver/deployments/resume-deployment-1.mdx b/...erver/deployments/resume-deployment-1.mdx → ...erver/deployments/resume-deployment-1.mdx
diff --git a/.../server/deployments/resume-deployment.mdx → .../server/deployments/resume-deployment.mdx b/.../server/deployments/resume-deployment.mdx → .../server/deployments/resume-deployment.mdx
diff --git a/...erver/deployments/schedule-deployment.mdx → ...erver/deployments/schedule-deployment.mdx b/...erver/deployments/schedule-deployment.mdx → ...erver/deployments/schedule-deployment.mdx
diff --git a/...eployments/update-deployment-schedule.mdx → ...eployments/update-deployment-schedule.mdx b/...eployments/update-deployment-schedule.mdx → ...eployments/update-deployment-schedule.mdx
diff --git a/.../server/deployments/update-deployment.mdx → .../server/deployments/update-deployment.mdx b/.../server/deployments/update-deployment.mdx → .../server/deployments/update-deployment.mdx
diff --git a/...ments/work-queue-check-for-deployment.mdx → ...ments/work-queue-check-for-deployment.mdx b/...ments/work-queue-check-for-deployment.mdx → ...ments/work-queue-check-for-deployment.mdx
diff --git a/...ef/server/events/count-account-events.mdx → ...pi/server/events/count-account-events.mdx b/...ef/server/events/count-account-events.mdx → ...pi/server/events/count-account-events.mdx
diff --git a/...c/api-ref/server/events/create-events.mdx → .../rest-api/server/events/create-events.mdx b/...c/api-ref/server/events/create-events.mdx → .../rest-api/server/events/create-events.mdx
diff --git a/...erver/events/read-account-events-page.mdx → ...erver/events/read-account-events-page.mdx b/...erver/events/read-account-events-page.mdx → ...erver/events/read-account-events-page.mdx
diff --git a/...0rc/api-ref/server/events/read-events.mdx → ...ef/rest-api/server/events/read-events.mdx b/...0rc/api-ref/server/events/read-events.mdx → ...ef/rest-api/server/events/read-events.mdx
diff --git a/...s/create-flow-run-notification-policy.mdx → ...s/create-flow-run-notification-policy.mdx b/...s/create-flow-run-notification-policy.mdx → ...s/create-flow-run-notification-policy.mdx
diff --git a/...s/delete-flow-run-notification-policy.mdx → ...s/delete-flow-run-notification-policy.mdx b/...s/delete-flow-run-notification-policy.mdx → ...s/delete-flow-run-notification-policy.mdx
diff --git a/...s/read-flow-run-notification-policies.mdx → ...s/read-flow-run-notification-policies.mdx b/...s/read-flow-run-notification-policies.mdx → ...s/read-flow-run-notification-policies.mdx
diff --git a/...ies/read-flow-run-notification-policy.mdx → ...ies/read-flow-run-notification-policy.mdx b/...ies/read-flow-run-notification-policy.mdx → ...ies/read-flow-run-notification-policy.mdx
diff --git a/...s/update-flow-run-notification-policy.mdx → ...s/update-flow-run-notification-policy.mdx b/...s/update-flow-run-notification-policy.mdx → ...s/update-flow-run-notification-policy.mdx
diff --git a/...r/flow-run-states/read-flow-run-state.mdx → ...r/flow-run-states/read-flow-run-state.mdx b/...r/flow-run-states/read-flow-run-state.mdx → ...r/flow-run-states/read-flow-run-state.mdx
diff --git a/.../flow-run-states/read-flow-run-states.mdx → .../flow-run-states/read-flow-run-states.mdx b/.../flow-run-states/read-flow-run-states.mdx → .../flow-run-states/read-flow-run-states.mdx
diff --git a/...r/flow-runs/average-flow-run-lateness.mdx → ...r/flow-runs/average-flow-run-lateness.mdx b/...r/flow-runs/average-flow-run-lateness.mdx → ...r/flow-runs/average-flow-run-lateness.mdx
diff --git a/...-ref/server/flow-runs/count-flow-runs.mdx → ...-api/server/flow-runs/count-flow-runs.mdx b/...-ref/server/flow-runs/count-flow-runs.mdx → ...-api/server/flow-runs/count-flow-runs.mdx
diff --git a/...flow-runs/count-task-runs-by-flow-run.mdx → ...flow-runs/count-task-runs-by-flow-run.mdx b/...flow-runs/count-task-runs-by-flow-run.mdx → ...flow-runs/count-task-runs-by-flow-run.mdx
diff --git a/...erver/flow-runs/create-flow-run-input.mdx → ...erver/flow-runs/create-flow-run-input.mdx b/...erver/flow-runs/create-flow-run-input.mdx → ...erver/flow-runs/create-flow-run-input.mdx
diff --git a/...-ref/server/flow-runs/create-flow-run.mdx → ...-api/server/flow-runs/create-flow-run.mdx b/...-ref/server/flow-runs/create-flow-run.mdx → ...-api/server/flow-runs/create-flow-run.mdx
diff --git a/...erver/flow-runs/delete-flow-run-input.mdx → ...erver/flow-runs/delete-flow-run-input.mdx b/...erver/flow-runs/delete-flow-run-input.mdx → ...erver/flow-runs/delete-flow-run-input.mdx
diff --git a/...-ref/server/flow-runs/delete-flow-run.mdx → ...-api/server/flow-runs/delete-flow-run.mdx b/...-ref/server/flow-runs/delete-flow-run.mdx → ...-api/server/flow-runs/delete-flow-run.mdx
diff --git a/...erver/flow-runs/filter-flow-run-input.mdx → ...erver/flow-runs/filter-flow-run-input.mdx b/...erver/flow-runs/filter-flow-run-input.mdx → ...erver/flow-runs/filter-flow-run-input.mdx
diff --git a/...ref/server/flow-runs/flow-run-history.mdx → ...api/server/flow-runs/flow-run-history.mdx b/...ref/server/flow-runs/flow-run-history.mdx → ...api/server/flow-runs/flow-run-history.mdx
diff --git a/...f/server/flow-runs/paginate-flow-runs.mdx → ...i/server/flow-runs/paginate-flow-runs.mdx b/...f/server/flow-runs/paginate-flow-runs.mdx → ...i/server/flow-runs/paginate-flow-runs.mdx
diff --git a/...rver/flow-runs/read-flow-run-graph-v1.mdx → ...rver/flow-runs/read-flow-run-graph-v1.mdx b/...rver/flow-runs/read-flow-run-graph-v1.mdx → ...rver/flow-runs/read-flow-run-graph-v1.mdx
diff --git a/...rver/flow-runs/read-flow-run-graph-v2.mdx → ...rver/flow-runs/read-flow-run-graph-v2.mdx b/...rver/flow-runs/read-flow-run-graph-v2.mdx → ...rver/flow-runs/read-flow-run-graph-v2.mdx
diff --git a/...erver/flow-runs/read-flow-run-history.mdx → ...erver/flow-runs/read-flow-run-history.mdx b/...erver/flow-runs/read-flow-run-history.mdx → ...erver/flow-runs/read-flow-run-history.mdx
diff --git a/.../server/flow-runs/read-flow-run-input.mdx → .../server/flow-runs/read-flow-run-input.mdx b/.../server/flow-runs/read-flow-run-input.mdx → .../server/flow-runs/read-flow-run-input.mdx
diff --git a/...pi-ref/server/flow-runs/read-flow-run.mdx → ...st-api/server/flow-runs/read-flow-run.mdx b/...pi-ref/server/flow-runs/read-flow-run.mdx → ...st-api/server/flow-runs/read-flow-run.mdx
diff --git a/...i-ref/server/flow-runs/read-flow-runs.mdx → ...t-api/server/flow-runs/read-flow-runs.mdx b/...i-ref/server/flow-runs/read-flow-runs.mdx → ...t-api/server/flow-runs/read-flow-runs.mdx
diff --git a/...-ref/server/flow-runs/resume-flow-run.mdx → ...-api/server/flow-runs/resume-flow-run.mdx b/...-ref/server/flow-runs/resume-flow-run.mdx → ...-api/server/flow-runs/resume-flow-run.mdx
diff --git a/...f/server/flow-runs/set-flow-run-state.mdx → ...i/server/flow-runs/set-flow-run-state.mdx b/...f/server/flow-runs/set-flow-run-state.mdx → ...i/server/flow-runs/set-flow-run-state.mdx
diff --git a/...-ref/server/flow-runs/update-flow-run.mdx → ...-api/server/flow-runs/update-flow-run.mdx b/...-ref/server/flow-runs/update-flow-run.mdx → ...-api/server/flow-runs/update-flow-run.mdx
diff --git a/...erver/flows/count-deployments-by-flow.mdx → ...erver/flows/count-deployments-by-flow.mdx b/...erver/flows/count-deployments-by-flow.mdx → ...erver/flows/count-deployments-by-flow.mdx
diff --git a/....0rc/api-ref/server/flows/count-flows.mdx → ...ref/rest-api/server/flows/count-flows.mdx b/....0rc/api-ref/server/flows/count-flows.mdx → ...ref/rest-api/server/flows/count-flows.mdx
diff --git a/....0rc/api-ref/server/flows/create-flow.mdx → ...ref/rest-api/server/flows/create-flow.mdx b/....0rc/api-ref/server/flows/create-flow.mdx → ...ref/rest-api/server/flows/create-flow.mdx
diff --git a/....0rc/api-ref/server/flows/delete-flow.mdx → ...ref/rest-api/server/flows/delete-flow.mdx b/....0rc/api-ref/server/flows/delete-flow.mdx → ...ref/rest-api/server/flows/delete-flow.mdx
diff --git a/...pi-ref/server/flows/next-runs-by-flow.mdx → ...st-api/server/flows/next-runs-by-flow.mdx b/...pi-ref/server/flows/next-runs-by-flow.mdx → ...st-api/server/flows/next-runs-by-flow.mdx
diff --git a/...c/api-ref/server/flows/paginate-flows.mdx → .../rest-api/server/flows/paginate-flows.mdx b/...c/api-ref/server/flows/paginate-flows.mdx → .../rest-api/server/flows/paginate-flows.mdx
diff --git a/...pi-ref/server/flows/read-flow-by-name.mdx → ...st-api/server/flows/read-flow-by-name.mdx b/...pi-ref/server/flows/read-flow-by-name.mdx → ...st-api/server/flows/read-flow-by-name.mdx
diff --git a/.../3.0rc/api-ref/server/flows/read-flow.mdx → ...i-ref/rest-api/server/flows/read-flow.mdx b/.../3.0rc/api-ref/server/flows/read-flow.mdx → ...i-ref/rest-api/server/flows/read-flow.mdx
diff --git a/...3.0rc/api-ref/server/flows/read-flows.mdx → ...-ref/rest-api/server/flows/read-flows.mdx b/...3.0rc/api-ref/server/flows/read-flows.mdx → ...-ref/rest-api/server/flows/read-flows.mdx
diff --git a/....0rc/api-ref/server/flows/update-flow.mdx → ...ref/rest-api/server/flows/update-flow.mdx b/....0rc/api-ref/server/flows/update-flow.mdx → ...ref/rest-api/server/flows/update-flow.mdx
diff --git a/docs/3.0rc/api-ref/rest-api/server/index.mdx b/docs/3.0rc/api-ref/rest-api/server/index.mdx
@@ -0,0 +1,9 @@
+---
+title: Server API Overview
+description: The Prefect server API enables you to interact programmatically with self-hosted Prefect server.
+---
+
+The self-hosted Prefect server API is organized around REST. 
+Select links in the left navigation menu to explore.
+
+Learn about [self-hosting Prefect server](/3.0rc/manage/self-host/).
diff --git a/...3.0rc/api-ref/server/logs/create-logs.mdx → ...-ref/rest-api/server/logs/create-logs.mdx b/...3.0rc/api-ref/server/logs/create-logs.mdx → ...-ref/rest-api/server/logs/create-logs.mdx
diff --git a/docs/3.0rc/api-ref/server/logs/read-logs.mdx → ...pi-ref/rest-api/server/logs/read-logs.mdx b/docs/3.0rc/api-ref/server/logs/read-logs.mdx → ...pi-ref/rest-api/server/logs/read-logs.mdx
diff --git a/....0rc/api-ref/server/root/health-check.mdx → ...ref/rest-api/server/root/health-check.mdx b/....0rc/api-ref/server/root/health-check.mdx → ...ref/rest-api/server/root/health-check.mdx
diff --git a/docs/3.0rc/api-ref/server/root/hello.mdx → ...rc/api-ref/rest-api/server/root/hello.mdx b/docs/3.0rc/api-ref/server/root/hello.mdx → ...rc/api-ref/rest-api/server/root/hello.mdx
diff --git a/...f/server/root/perform-readiness-check.mdx → ...i/server/root/perform-readiness-check.mdx b/...f/server/root/perform-readiness-check.mdx → ...i/server/root/perform-readiness-check.mdx
diff --git a/...rc/api-ref/server/root/server-version.mdx → ...f/rest-api/server/root/server-version.mdx b/...rc/api-ref/server/root/server-version.mdx → ...f/rest-api/server/root/server-version.mdx
diff --git a/...ver/savedsearches/create-saved-search.mdx → ...ver/savedsearches/create-saved-search.mdx b/...ver/savedsearches/create-saved-search.mdx → ...ver/savedsearches/create-saved-search.mdx
diff --git a/...ver/savedsearches/delete-saved-search.mdx → ...ver/savedsearches/delete-saved-search.mdx b/...ver/savedsearches/delete-saved-search.mdx → ...ver/savedsearches/delete-saved-search.mdx
diff --git a/...erver/savedsearches/read-saved-search.mdx → ...erver/savedsearches/read-saved-search.mdx b/...erver/savedsearches/read-saved-search.mdx → ...erver/savedsearches/read-saved-search.mdx
diff --git a/...ver/savedsearches/read-saved-searches.mdx → ...ver/savedsearches/read-saved-searches.mdx b/...ver/savedsearches/read-saved-searches.mdx → ...ver/savedsearches/read-saved-searches.mdx
diff --git a/docs/3.0rc/api-ref/server/schema.json → ...3.0rc/api-ref/rest-api/server/schema.json b/docs/3.0rc/api-ref/server/schema.json → ...3.0rc/api-ref/rest-api/server/schema.json
diff --git a/...r/task-run-states/read-task-run-state.mdx → ...r/task-run-states/read-task-run-state.mdx b/...r/task-run-states/read-task-run-state.mdx → ...r/task-run-states/read-task-run-state.mdx
diff --git a/.../task-run-states/read-task-run-states.mdx → .../task-run-states/read-task-run-states.mdx b/.../task-run-states/read-task-run-states.mdx → .../task-run-states/read-task-run-states.mdx
diff --git a/...-ref/server/task-runs/count-task-runs.mdx → ...-api/server/task-runs/count-task-runs.mdx b/...-ref/server/task-runs/count-task-runs.mdx → ...-api/server/task-runs/count-task-runs.mdx
diff --git a/...-ref/server/task-runs/create-task-run.mdx → ...-api/server/task-runs/create-task-run.mdx b/...-ref/server/task-runs/create-task-run.mdx → ...-api/server/task-runs/create-task-run.mdx
diff --git a/...-ref/server/task-runs/delete-task-run.mdx → ...-api/server/task-runs/delete-task-run.mdx b/...-ref/server/task-runs/delete-task-run.mdx → ...-api/server/task-runs/delete-task-run.mdx
diff --git a/...k-runs/read-dashboard-task-run-counts.mdx → ...k-runs/read-dashboard-task-run-counts.mdx b/...k-runs/read-dashboard-task-run-counts.mdx → ...k-runs/read-dashboard-task-run-counts.mdx
diff --git a/...sk-runs/read-task-run-counts-by-state.mdx → ...sk-runs/read-task-run-counts-by-state.mdx b/...sk-runs/read-task-run-counts-by-state.mdx → ...sk-runs/read-task-run-counts-by-state.mdx
diff --git a/...pi-ref/server/task-runs/read-task-run.mdx → ...st-api/server/task-runs/read-task-run.mdx b/...pi-ref/server/task-runs/read-task-run.mdx → ...st-api/server/task-runs/read-task-run.mdx
diff --git a/...i-ref/server/task-runs/read-task-runs.mdx → ...t-api/server/task-runs/read-task-runs.mdx b/...i-ref/server/task-runs/read-task-runs.mdx → ...t-api/server/task-runs/read-task-runs.mdx
diff --git a/...f/server/task-runs/set-task-run-state.mdx → ...i/server/task-runs/set-task-run-state.mdx b/...f/server/task-runs/set-task-run-state.mdx → ...i/server/task-runs/set-task-run-state.mdx
diff --git a/...ref/server/task-runs/task-run-history.mdx → ...api/server/task-runs/task-run-history.mdx b/...ref/server/task-runs/task-run-history.mdx → ...api/server/task-runs/task-run-history.mdx
diff --git a/...-ref/server/task-runs/update-task-run.mdx → ...-api/server/task-runs/update-task-run.mdx b/...-ref/server/task-runs/update-task-run.mdx → ...-api/server/task-runs/update-task-run.mdx
diff --git a/.../3.0rc/api-ref/server/ui/validate-obj.mdx → ...i-ref/rest-api/server/ui/validate-obj.mdx b/.../3.0rc/api-ref/server/ui/validate-obj.mdx → ...i-ref/rest-api/server/ui/validate-obj.mdx
diff --git a/...-ref/server/variables/count-variables.mdx → ...-api/server/variables/count-variables.mdx b/...-ref/server/variables/count-variables.mdx → ...-api/server/variables/count-variables.mdx
diff --git a/...-ref/server/variables/create-variable.mdx → ...-api/server/variables/create-variable.mdx b/...-ref/server/variables/create-variable.mdx → ...-api/server/variables/create-variable.mdx
diff --git a/...ver/variables/delete-variable-by-name.mdx → ...ver/variables/delete-variable-by-name.mdx b/...ver/variables/delete-variable-by-name.mdx → ...ver/variables/delete-variable-by-name.mdx
diff --git a/...-ref/server/variables/delete-variable.mdx → ...-api/server/variables/delete-variable.mdx b/...-ref/server/variables/delete-variable.mdx → ...-api/server/variables/delete-variable.mdx
diff --git a/...erver/variables/read-variable-by-name.mdx → ...erver/variables/read-variable-by-name.mdx b/...erver/variables/read-variable-by-name.mdx → ...erver/variables/read-variable-by-name.mdx
diff --git a/...pi-ref/server/variables/read-variable.mdx → ...st-api/server/variables/read-variable.mdx b/...pi-ref/server/variables/read-variable.mdx → ...st-api/server/variables/read-variable.mdx
diff --git a/...i-ref/server/variables/read-variables.mdx → ...t-api/server/variables/read-variables.mdx b/...i-ref/server/variables/read-variables.mdx → ...t-api/server/variables/read-variables.mdx
diff --git a/...ver/variables/update-variable-by-name.mdx → ...ver/variables/update-variable-by-name.mdx b/...ver/variables/update-variable-by-name.mdx → ...ver/variables/update-variable-by-name.mdx
diff --git a/...-ref/server/variables/update-variable.mdx → ...-api/server/variables/update-variable.mdx b/...-ref/server/variables/update-variable.mdx → ...-api/server/variables/update-variable.mdx
diff --git a/...ef/server/work-pools/count-work-pools.mdx → ...pi/server/work-pools/count-work-pools.mdx b/...ef/server/work-pools/count-work-pools.mdx → ...pi/server/work-pools/count-work-pools.mdx
diff --git a/...ef/server/work-pools/create-work-pool.mdx → ...pi/server/work-pools/create-work-pool.mdx b/...ef/server/work-pools/create-work-pool.mdx → ...pi/server/work-pools/create-work-pool.mdx
diff --git a/...f/server/work-pools/create-work-queue.mdx → ...i/server/work-pools/create-work-queue.mdx b/...f/server/work-pools/create-work-queue.mdx → ...i/server/work-pools/create-work-queue.mdx
diff --git a/...ef/server/work-pools/delete-work-pool.mdx → ...pi/server/work-pools/delete-work-pool.mdx b/...ef/server/work-pools/delete-work-pool.mdx → ...pi/server/work-pools/delete-work-pool.mdx
diff --git a/...f/server/work-pools/delete-work-queue.mdx → ...i/server/work-pools/delete-work-queue.mdx b/...f/server/work-pools/delete-work-queue.mdx → ...i/server/work-pools/delete-work-queue.mdx
diff --git a/...i-ref/server/work-pools/delete-worker.mdx → ...t-api/server/work-pools/delete-worker.mdx b/...i-ref/server/work-pools/delete-worker.mdx → ...t-api/server/work-pools/delete-worker.mdx
diff --git a/...er/work-pools/get-scheduled-flow-runs.mdx → ...er/work-pools/get-scheduled-flow-runs.mdx b/...er/work-pools/get-scheduled-flow-runs.mdx → ...er/work-pools/get-scheduled-flow-runs.mdx
diff --git a/...-ref/server/work-pools/read-work-pool.mdx → ...-api/server/work-pools/read-work-pool.mdx b/...-ref/server/work-pools/read-work-pool.mdx → ...-api/server/work-pools/read-work-pool.mdx
diff --git a/...ref/server/work-pools/read-work-pools.mdx → ...api/server/work-pools/read-work-pools.mdx b/...ref/server/work-pools/read-work-pools.mdx → ...api/server/work-pools/read-work-pools.mdx
diff --git a/...ref/server/work-pools/read-work-queue.mdx → ...api/server/work-pools/read-work-queue.mdx b/...ref/server/work-pools/read-work-queue.mdx → ...api/server/work-pools/read-work-queue.mdx
diff --git a/...ef/server/work-pools/read-work-queues.mdx → ...pi/server/work-pools/read-work-queues.mdx b/...ef/server/work-pools/read-work-queues.mdx → ...pi/server/work-pools/read-work-queues.mdx
diff --git a/...pi-ref/server/work-pools/read-workers.mdx → ...st-api/server/work-pools/read-workers.mdx b/...pi-ref/server/work-pools/read-workers.mdx → ...st-api/server/work-pools/read-workers.mdx
diff --git a/...ef/server/work-pools/update-work-pool.mdx → ...pi/server/work-pools/update-work-pool.mdx b/...ef/server/work-pools/update-work-pool.mdx → ...pi/server/work-pools/update-work-pool.mdx
diff --git a/...f/server/work-pools/update-work-queue.mdx → ...i/server/work-pools/update-work-queue.mdx b/...f/server/work-pools/update-work-queue.mdx → ...i/server/work-pools/update-work-queue.mdx
diff --git a/...ef/server/work-pools/worker-heartbeat.mdx → ...pi/server/work-pools/worker-heartbeat.mdx b/...ef/server/work-pools/worker-heartbeat.mdx → ...pi/server/work-pools/worker-heartbeat.mdx
diff --git a/.../server/work-queues/create-work-queue.mdx → .../server/work-queues/create-work-queue.mdx b/.../server/work-queues/create-work-queue.mdx → .../server/work-queues/create-work-queue.mdx
diff --git a/.../server/work-queues/delete-work-queue.mdx → .../server/work-queues/delete-work-queue.mdx b/.../server/work-queues/delete-work-queue.mdx → .../server/work-queues/delete-work-queue.mdx
diff --git a/...r/work-queues/read-work-queue-by-name.mdx → ...r/work-queues/read-work-queue-by-name.mdx b/...r/work-queues/read-work-queue-by-name.mdx → ...r/work-queues/read-work-queue-by-name.mdx
diff --git a/...rver/work-queues/read-work-queue-runs.mdx → ...rver/work-queues/read-work-queue-runs.mdx b/...rver/work-queues/read-work-queue-runs.mdx → ...rver/work-queues/read-work-queue-runs.mdx
diff --git a/...er/work-queues/read-work-queue-status.mdx → ...er/work-queues/read-work-queue-status.mdx b/...er/work-queues/read-work-queue-status.mdx → ...er/work-queues/read-work-queue-status.mdx
diff --git a/...ef/server/work-queues/read-work-queue.mdx → ...pi/server/work-queues/read-work-queue.mdx b/...ef/server/work-queues/read-work-queue.mdx → ...pi/server/work-queues/read-work-queue.mdx
diff --git a/...f/server/work-queues/read-work-queues.mdx → ...i/server/work-queues/read-work-queues.mdx b/...f/server/work-queues/read-work-queues.mdx → ...i/server/work-queues/read-work-queues.mdx
diff --git a/.../server/work-queues/update-work-queue.mdx → .../server/work-queues/update-work-queue.mdx b/.../server/work-queues/update-work-queue.mdx → .../server/work-queues/update-work-queue.mdx
diff --git a/docs/3.0rc/api-ref/server/index.mdx b/docs/3.0rc/api-ref/server/index.mdx