Skip to content
URL:
https://<root>/services/createFolder
Methods:
POST
Version Introduced:
10.9

Access requirements

Required privileges

The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.


Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.


Learn how to generate a token

Description

The createFolder operation creates a subfolder under the root Services folder. The createFolder operation is only supported on the root folder, as ArcGIS Enterprise on Kubernetes only supports a single-level hierarchy of folders.

Request parameters

ParameterDetails

folderName

(Required)

The name of the folder. The name must be unique.

Example
Use dark colors for code blocksCopy
1
folderName=SalzburgCity

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the createFolder operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /<context>/admin/services/createFolder HTTP /1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

folderName=SalzburgCity&f=psjon&token=ELIMsyURgefHIZ-x6PzynYsaxLNR30GbWE6PCpgD0Hu7dWQ3vmBLz3bljwvJC8a74K_XARVfs5lpmCkjLkMZANHIDgMHiwgwnNiQBbTWHEbNqJeodE9ipXYeUmlGkveMQ44JjNQlNGYim-LqV4DcrPynxBlvO0CsIT4RIB-OsYp6oU_jqS9xVHxcHwCtvu3rnikAqeb3S96aS0ntC-414Y23t1CWAVhDSmRrl7NyWgw-jN4VBZ3FvPnDDDoFooY

JSON Response example

The following sample response is returned when createFolder is successful:

Use dark colors for code blocksCopy
1
{"status": "success"}

The following sample response is returned when folderName contains spacing:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "error" : {
    "code" : 500,
    "message" : "Folder name is invalid. The name contains illegal character ' '.",
    "details" : null
  }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.