DA Admin API (1.0-RC)

Download OpenAPI specification:

DA Admin API is used to manage Document Authoring content repositories.

Source

The source API allows you to work directly with your content sources (Docs, Sheets, Media).

Get source content

Get a content source from an organization.

Important: For files, the path parameter must include the file extension (e.g., myfile.html, data.json). The full URL would be: /source/{org}/{repo}/myfile.html

Authorizations:

bearer

path Parameters

org required	string The organization.
repo required	string Name of the repository.
path required	string Path to the source content.

Responses

Response samples

200

Content type

text/html

<body>
  <header></header>
  <main>
    <div></div>
  </main>
</body>

Create or replace source content

Create or replace a content source within an organization.

Accepts either a multipart/form-data body with the content in the data field, or a raw request body for text-based types (text/html, application/json).

The multipart/form-data body may also include an optional guid field. When the target location does not already have a stored identifier, guid becomes the document identifier. It must be a UUID. A guid that is not a UUID is rejected with a 400 response. When the target already has a stored identifier that differs from guid, the request is rejected with a 409 response. When omitted, the service generates a UUID.

Important: For files, the path parameter must include the file extension (e.g., myfile.html, data.json). For folders, omit the extension (e.g., myfolder).

Authorizations:

bearer

path Parameters

org required	string The organization.
repo required	string Name of the repository.
path required	string Path to the source content.

Request Body schema:
multipart/form-data

data

string <binary>

The content to store at the specified location.

guid

string <uuid>

Optional client-supplied identifier for the document. When the target location does not already have a stored identifier, this value becomes the document identifier. It must be a UUID. A value that is not a UUID is rejected with a 400 response. When the target already has a stored identifier that differs from this value, the request is rejected with a 409 response. When omitted, the service generates a UUID.

Responses

Request samples

Payload

Content type

multipart/form-data

destination: '/aemsites/geometrixx/path/to/file.html'

Response samples

201

Content type

application/json

{"source": {"editUrl": "https://da.live/edit#/adobecom/blog/my-cool-post",
"contentUrl": "https://content.da.live/adobecom/blog/my-cool-post",
"props": {"readyForLoc": true,
"lastRollout": "Wed, 29 Nov 2023 01:20:40 GMT"
}
},
"aem": {"previewUrl": "https://main--blog--adobecom.aem.page/my-cool-post",
"liveUrl": "https://main--blog--adobecom.aem.live/my-cool-post"
}
}

Create source content

Create a content source within an organization.

Accepts either a multipart/form-data body with the content in the data field, or a raw request body for text-based types (text/html, application/json).

The multipart/form-data body may also include an optional guid field. When the target location does not already have a stored identifier, guid becomes the document identifier. It must be a UUID. A guid that is not a UUID is rejected with a 400 response. When the target already has a stored identifier that differs from guid, the request is rejected with a 409 response. When omitted, the service generates a UUID.

Important: For files, the path parameter must include the file extension (e.g., myfile.html, data.json). For folders, omit the extension (e.g., myfolder). Examples:

File: /source/{org}/{repo}/myfile.html
Folder: /source/{org}/{repo}/myfolder

Authorizations:

bearer

path Parameters

org required	string The organization.
repo required	string Name of the repository.
path required	string Path to the source content.

Request Body schema:
multipart/form-data

data

string <binary>

The content to store at the specified location.

guid

string <uuid>

Optional client-supplied identifier for the document. When the target location does not already have a stored identifier, this value becomes the document identifier. It must be a UUID. A value that is not a UUID is rejected with a 400 response. When the target already has a stored identifier that differs from this value, the request is rejected with a 409 response. When omitted, the service generates a UUID.

Responses

Request samples

Payload

Content type

multipart/form-data

destination: '/aemsites/geometrixx/path/to/file.html'

Response samples

201

Content type

application/json

{"source": {"editUrl": "https://da.live/edit#/adobecom/blog/my-cool-post",
"contentUrl": "https://content.da.live/adobecom/blog/my-cool-post",
"props": {"readyForLoc": true,
"lastRollout": "Wed, 29 Nov 2023 01:20:40 GMT"
}
},
"aem": {"previewUrl": "https://main--blog--adobecom.aem.page/my-cool-post",
"liveUrl": "https://main--blog--adobecom.aem.live/my-cool-post"
}
}

Delete source content

Delete the content source or directory.

Important: The path parameter works as follows:

For files: Include the extension in the path (e.g., myfile.html)
For folders: Omit the extension (e.g., myfolder) Examples:
Delete file: /source/{org}/{repo}/myfile.html
Delete folder: /source/{org}/{repo}/myfolder

Authorizations:

bearer

path Parameters

org required	string The organization.
repo required	string Name of the repository.
path required	string Path to the source content.

Responses

Copy

The copy API allows you to copy a directory or source.

Copy source content

Copy a content source within an organization.

Important: The path parameter works as follows:

For files: Include the extension in the path (e.g., myfile.html)
For folders: Omit the extension (e.g., myfolder) Examples:
Copy file: /copy/{org}/{repo}/myfile.html
Copy folder: /copy/{org}/{repo}/myfolder

Authorizations:

bearer

path Parameters

org required	string The organization.
repo required	string Name of the repository.
path required	string Path to the source content.

Request Body schema: multipart/form-data

destination

string

The destination path of the copy.

Responses

Request samples

Payload

Content type

multipart/form-data

destination: '/aemsites/geometrixx/path/to/file.html'

Move

The move API allows you to move a directory or source.

Move source content

Move a content source within an organization.

Important: The path parameter works as follows:

For files: Include the extension in the path (e.g., myfile.html)
For folders: Omit the extension (e.g., myfolder) Examples:
Move file: /move/{org}/{repo}/myfile.html
Move folder: /move/{org}/{repo}/myfolder

Authorizations:

bearer

path Parameters

org required	string The organization.
repo required	string Name of the repository.
path required	string Path to the source content.

Request Body schema: multipart/form-data

destination

string

The destination path of the move.

Responses

Request samples

Payload

Content type

multipart/form-data

destination: '/aemsites/geometrixx/path/to/file.html'

Version

The versionsource and versionlist APIs allow you to work with versions of source documents and sheets.

Get source version

Returns version of a given source.

Important: The guid parameter must include the file extension (e.g., version-123.html, v2.json). Example: /versionsource/{org}/{repo}/version-123.html

Authorizations:

bearer

path Parameters

org required	string The organization.
repo required	string Name of the repository.
guid required	string GUID of the version source.

Responses

Response samples

200

Content type

text/html

<body>
  <header></header>
  <main>
    <div></div>
  </main>
</body>

Create source version

Create a version of a given source.

Important: The path parameter must include the file extension (e.g., myfile.html, data.json). Example: /versionsource/{org}/{repo}/myfile.html

Authorizations:

bearer

path Parameters

org required	string The organization.
repo required	string Name of the repository.
path required	string Path to the source content.

Responses

Response samples

200

Content type

application/json

[{"timestamp": 0,
"url": "string",
"path": "string",
"users": [{"email": "string"
}
]
}
]

List source versions

Returns a list of versions for a given source.

Important: The path parameter must include the file extension (e.g., myfile.html, data.json). Example: /versionlist/{org}/{repo}/myfile.html

Authorizations:

bearer

path Parameters

org required	string The organization.
repo required	string Name of the repository.
path required	string Path to the source content.

Responses

Response samples

200

Content type

application/json

[{"timestamp": 0,
"url": "string",
"path": "string",
"users": [{"email": "string"
}
]
}
]

List

The list API will list children of a directory.

List sources

Returns a list of sources from an organization.

Authorizations:

bearer

path Parameters

org required	string The organization.
repo required	string Name of the repository.
path required	string Path to the source content.

header Parameters

da-continuation-token

string

Continuation token from the previous list response header.

Responses

Response samples

200

Content type

application/json

{"sources": [{"editUrl": "string",
"contentUrl": "string",
"props": { }
}
]
}

Config

The config API will allow you to associate sheet-formatted configurations with orgs, sites, directories, documents, and sheets.

Config

Get a config for an org, repo, or source.

Authorizations:

bearer

path Parameters

org required	string The organization.
repo required	string Name of the repository.
path required	string Path to the source content.

Responses

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"offset": 0,
"data": [{"key": "string",
"value": "string"
}
],
":type": "string"
}

New config

Create a config for an org, repo, or source.

Authorizations:

bearer

path Parameters

org required	string The organization.
repo required	string Name of the repository.
path required	string Path to the source content.

Request Body schema: multipart/form-data

data

string <binary>

The content to store at the specified location.

guid

string <uuid>

Optional client-supplied identifier for the document. When the target location does not already have a stored identifier, this value becomes the document identifier. It must be a UUID. A value that is not a UUID is rejected with a 400 response. When the target already has a stored identifier that differs from this value, the request is rejected with a 409 response. When omitted, the service generates a UUID.

Responses

Request samples

Payload

Content type

multipart/form-data

destination: '/aemsites/geometrixx/path/to/file.html'

Response samples

201

Content type

application/json

{"source": {"editUrl": "https://da.live/edit#/adobecom/blog/my-cool-post",
"contentUrl": "https://content.da.live/adobecom/blog/my-cool-post",
"props": {"readyForLoc": true,
"lastRollout": "Wed, 29 Nov 2023 01:20:40 GMT"
}
},
"aem": {"previewUrl": "https://main--blog--adobecom.aem.page/my-cool-post",
"liveUrl": "https://main--blog--adobecom.aem.live/my-cool-post"
}
}

DA Admin API (1.0-RC)

Source

Get source content

Authorizations:

path Parameters

Responses

Response samples

Create or replace source content

Authorizations:

path Parameters

Request Body schema: multipart/form-datatext/htmlapplication/jsonmultipart/form-data

Responses

Request samples

Response samples

Create source content

Authorizations:

path Parameters

Request Body schema: multipart/form-datatext/htmlapplication/jsonmultipart/form-data

Responses

Request samples

Response samples

Delete source content

Authorizations:

path Parameters

Responses

Copy

Copy source content

Authorizations:

path Parameters

Request Body schema: multipart/form-data

Responses

Request samples

Move

Move source content

Authorizations:

path Parameters

Request Body schema: multipart/form-data

Responses

Request samples

Version

Get source version

Authorizations:

path Parameters

Responses

Response samples

Create source version

Authorizations:

path Parameters

Responses

Response samples

List source versions

Authorizations:

path Parameters

Responses

Response samples

List

List sources

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Config

Config

Authorizations:

path Parameters

Responses

Response samples

New config

Authorizations:

path Parameters

Request Body schema: multipart/form-data

Responses

Request samples

Response samples

Request Body schema:
multipart/form-data

Request Body schema:
multipart/form-data