/tags/api/Recent content in Api on Layer5 DocumentationHugoen/cloud/reference/workspaces-and-environments/Mon, 01 Jan 0001 00:00:00 +0000/cloud/reference/workspaces-and-environments/<p>This page states how workspaces and environments behave, exactly. For the model, read the <a href="/cloud/concepts/workspaces/">Workspaces</a> and <a href="/cloud/concepts/environments/">Environments</a> concepts. For tasks, use the <a href="/cloud/guides/workspaces/">workspace guides</a>. For every endpoint&rsquo;s schema, see the <a href="/cloud/reference/api-reference/rest/">REST API Reference</a>, and for base URL and authentication see the <a href="/cloud/reference/api-reference/">Cloud API</a>. All paths below sit under <code>/api</code>.</p> <h2 id="fields-defaults-and-limits" class="heading-link"> Fields, defaults, and limits <a href="#fields-defaults-and-limits" class="heading-anchor" aria-label="Permalink to this heading">🔗</a> </h2> <table> <thead> <tr> <th>Property</th> <th>Workspace</th> <th>Environment</th> </tr> </thead> <tbody> <tr> <td>Name</td> <td>Up to 255 characters. Not required or unique on the API.</td> <td>Up to 255 characters. Not required or unique on the API.</td> </tr> <tr> <td>Description</td> <td>Up to 255 characters. May be empty.</td> <td>Up to 255 characters. May be empty.</td> </tr> <tr> <td>Organization</td> <td>Required on create. Fixed for the life of the workspace.</td> <td>Required on create (<code>organizationId is required</code>). Fixed for the life of the environment.</td> </tr> <tr> <td>Owner</td> <td>The user who created it.</td> <td>Not recorded on create.</td> </tr> <tr> <td>Starting state</td> <td>No teams, environments, designs, or views.</td> <td>No connections, in no workspace.</td> </tr> <tr> <td>Kind</td> <td>Single kind.</td> <td>Ordinary when created through the API. Platform-provisioned environments exist and are protected.</td> </tr> <tr> <td>Update</td> <td>Only the fields sent change.</td> <td>Name and description are both replaced; an omitted field becomes empty.</td> </tr> <tr> <td>Plan check</td> <td>None.</td> <td>None. The feature matrix lists environments under Enterprise.</td> </tr> <tr> <td>Count limits</td> <td>None. An organization must keep at least one workspace.</td> <td>None.</td> </tr> </tbody> </table> <p>Layer5 Cloud creates <strong>My Workspace</strong> in any organization that has no workspace.</p>/cloud/reference/api-reference/Mon, 01 Jan 0001 00:00:00 +0000/cloud/reference/api-reference/<p>The Layer5 Cloud REST API lets you build integrations, retrieve data, and automate your infrastructure. This page states the conventions every endpoint shares: base URL, authentication, organization context, pagination, and errors. For the list of endpoints, see the <a href="/cloud/reference/api-reference/rest/">REST API Reference</a>.</p> <h2 id="base-url" class="heading-link"> Base URL <a href="#base-url" class="heading-anchor" aria-label="Permalink to this heading">🔗</a> </h2> <p>Every endpoint lives under <code>/api</code> on the host of your Layer5 Cloud deployment.</p> <table> <thead> <tr> <th>Deployment</th> <th>Base URL</th> </tr> </thead> <tbody> <tr> <td>Hosted Layer5 Cloud</td> <td><code>https://cloud.layer5.io/api</code></td> </tr> <tr> <td>Self-hosted</td> <td><code>https://&lt;your-cloud-host&gt;/api</code></td> </tr> </tbody> </table> <h2 id="authentication" class="heading-link"> Authentication <a href="#authentication" class="heading-anchor" aria-label="Permalink to this heading">🔗</a> </h2> <p>Authenticate with a <a href="/cloud/concepts/identity-and-security/tokens/">security token</a>. Send it as a bearer token in the <code>Authorization</code> header:</p>