| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | — | link | — | — | — |
Actions (25)
Static Assets · 8
- Copy assetsPOST /api/3.0/staticassets/copy
Copy assets to a different directory.
documented - Create folderPOST /api/3.0/staticassets/folder
Create a new folder in the assets directory.
documented - Delete assetsDELETE /api/3.0/staticassets
Delete one or more assets (files or folders) by path.
documented - Download assetsGET /api/3.0/staticassets/download
Download assets (single or ZIP for multiple) from a directory.
documented - List assetsGET /api/3.0/staticassets
List assets and folders in a directory.
documented - Move assetsPOST /api/3.0/staticassets/move
Move assets to a different directory.
documented - Rename assetPUT /api/3.0/staticassets/rename
Rename a file or folder in the assets directory.
documented - Upload assetsPOST /api/3.0/staticassets
Upload one or more files to a directory.
documented
Entity Management · 7
- Create recordPOST /api/3.0/entity/{entity_name}
Create new record(s) for an entity.
documented - Delete recordDELETE /api/3.0/entity/{entity_name}/{record_id}
Delete a single record by ID.
documented - Delete recordsDELETE /api/3.0/entity/{entity_name}
Delete one or more records by IDs in the request body.
documented - Read recordGET /api/3.0/entity/{entity_name}/{record_id}
Retrieve a single record by ID.
documented - Read recordsGET /api/3.0/entity/{entity_name}
Retrieve a list of records for an entity with optional field lists, sorting, and paging.
documented - Read related dataGET /api/3.0/entity/{entity_name}/{record_id}/{navigation_property}
Retrieve related data for a parent record via a navigation property.
documented - Update recordPATCH /api/3.0/entity/{entity_name}/{record_id}
Update an existing record by ID.
documented
Metadata · 5
- Describe an entityGET /api/3.0/entity/{entity_name}/metadata
Describe metadata for the specified entity.
documented - Describe an entity fieldGET /api/3.0/entity/{entity_name}/metadata/{field_name}
Describe metadata for the specified field of an entity.
documented - Describe entitiesGET /api/3.0/entity/metadata
Describe metadata for the requested entities.
documented - List entitiesGET /api/3.0/entity
Retrieve the list of Magentrix entities.
documented - List entitiesGET /api/3.0/entity
(Additional listing for completeness in the catalog.)
documented