Skip to main content

Shipyard URL Structures#

Definition#

All URLs within Shipyard follow a consistent format that's built on internal IDs and names. When used in combination with the Shipyard Environment Variables, this can be a useful way to link a user directly to an area of the platform that you want them to view, edit, or run manually.

Below is a list of the most common URL structures that may be needed.

PurposeURL Structure
View All Projectshttps://app.shipyardapp.com/{org_name}/projects
View all Blueprintshttps://app.shipyardapp.com/{org_name}/blueprints
View a Single Blueprinthttps://app.shipyardapp.com/{org_name}/blueprints/{blueprint_id}
View Vessels in Single Projecthttps://app.shipyardapp.com/{org_name}/projects/{project_id}/vessels
View Fleets for a Single Projecthttps://app.shipyardapp.com/{org_name}/projects/{project_id}/fleets
View Logs for a Single Fleethttps://app.shipyardapp.com/{org_name}/projects/{project_id}/fleets/{fleet_id}/logs
View Individual Log for a Fleethttps://app.shipyardapp.com/{org_name}/projects/{project_id}/fleets/{fleet_id}/logs/{log_id}
View Logs for a Single Vesselhttps://app.shipyardapp.com/{org_name}/projects/{project_id}/vessels/{vessel_id}/logs
View Individual Log for a Vesselhttps://app.shipyardapp.com/{org_name}/projects/{project_id}/vessels/{vessel_id}/logs/{log_id}

Additional Notes#

  1. Shipyard first checks to verify that the user visiting the page has access to the underlying content. If not, they will be redirected to the login screen.