API ReferencePrivate API Network

Add a workspace

View as Markdown
Publishes a workspace in your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).

Authentication

x-api-keystring
API Key authentication via header
OR
Authorizationstring
A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
OR
AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

This endpoint expects an object.
workspaceobjectRequired

Response

Created
addedAtdatetime
The date and time at which the element was added.
addedByinteger
The user who added the element.
createdByinteger
The user who created the element.
createdAtdatetime
The date and time at which the element was created.
updatedByinteger
The user who last updated the element.
updatedAtdatetime
The date and time at which the element was last updated.
typeenum

The workspace element.

idstring
The element's ID
namestring
The element's name.
summarystring or null
The element's summary.
descriptionstring or null
The element's description.
hrefstringformat: "url"
The element's Postman URL.
parentFolderIdinteger or nullDeprecated
This property is deprecated.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error