The major AAM release is live! For questions or concerns, visit the Release Page.
API Routes
About 2 min
Get All Routes
Fetch a comprehensive list of all registered RESTful API endpoints on your website.
Endpoint
GET /aam/v2/api-routes
Parameters
| Name | Description |
|---|---|
access_level | Required. Can be either "role", "user", "visitor" or "default". |
role_id | Conditionally required if access_level is "role". |
user_id | Conditionally required if access_level is "user". |
Response Sample
[
{
"id": 3681523478,
"route": "/",
"method": "GET",
"is_restricted": false,
"is_inherited": true
},
{
"id": 1409992110,
"route": "/batch/v1",
"method": "POST",
"is_restricted": false,
"is_inherited": true
},
{
"id": 2773338009,
"route": "/oembed/1.0",
"method": "GET",
"is_restricted": false,
"is_inherited": true
},
{
"..."
},
{
"id": 1576724901,
"route": "/wp-block-editor/v1/export",
"method": "GET",
"is_restricted": false,
"is_inherited": true
},
{
"id": 928615128,
"route": "/wp-block-editor/v1/navigation-fallback",
"method": "GET",
"is_restricted": false,
"is_inherited": true
},
{
"id": 3759883368,
"route": "/wp/v2/font-collections",
"method": "GET",
"is_restricted": false,
"is_inherited": true
},
{
"id": 3185059763,
"route": "/wp/v2/font-collections/(?p<slug>[\\/\\w-]+)",
"method": "GET",
"is_restricted": false,
"is_inherited": true
}
]
Get Single Route
Fetch details of a single API route by its ID.
Endpoint
GET /aam/v2/api-route/<id>
Parameters
| Name | Description |
|---|---|
access_level | Required. Can be either "role", "user", "visitor" or "default". |
role_id | Conditionally required if access_level is "role". |
user_id | Conditionally required if access_level is "user". |
id | Required. Unique numeric API Route ID generated by AAM. |
Response Sample
{
"id": 3681523478,
"route": "/",
"method": "GET",
"is_restricted": true,
"is_inherited": false
}
Update Route Permissions
Set or update permissions for a specific route.
Endpoint
POST /aam/v2/api-route/<id>PATCH /aam/v2/api-route/<id>
Parameters
| Name | Description |
|---|---|
access_level | Required. Can be either "role", "user", "visitor" or "default". |
role_id | Conditionally required if access_level is "role". |
user_id | Conditionally required if access_level is "user". |
id | Required. Unique numeric route ID generated by AAM. |
is_restricted | Required. Whether the API route is restricted or not. Default is true. |
Response Sample
{
"id": 3681523478,
"route": "/",
"method": "GET",
"is_restricted": true,
"is_inherited": false
}
Reset Route Permissions
Reset permissions for a specific API route to default.
Endpoint
DELETE /aam/v2/api-route/<id>
Parameters
| Name | Description |
|---|---|
access_level | Required. Can be either "role", "user", "visitor" or "default". |
role_id | Conditionally required if access_level is "role". |
user_id | Conditionally required if access_level is "user". |
id | Required. Unique numeric API route ID generated by AAM. |
Response Sample
{
"id": 3681523478,
"route": "/",
"method": "GET",
"is_restricted": false,
"is_inherited": true
}
Reset All Permissions
Reset all API route permissions to default.
Endpoint
DELETE /aam/v2/api-routes
Parameters
| Name | Description |
|---|---|
access_level | Required. Can be either "role", "user", "visitor" or "default". |
role_id | Conditionally required if access_level is "role". |
user_id | Conditionally required if access_level is "user". |
Response Sample
[
{
"id": 3681523478,
"route": "/",
"method": "GET",
"is_restricted": false,
"is_inherited": true
},
{
"id": 1409992110,
"route": "/batch/v1",
"method": "POST",
"is_restricted": false,
"is_inherited": true
},
{
"id": 2773338009,
"route": "/oembed/1.0",
"method": "GET",
"is_restricted": false,
"is_inherited": true
},
{
"..."
},
{
"id": 1576724901,
"route": "/wp-block-editor/v1/export",
"method": "GET",
"is_restricted": false,
"is_inherited": true
},
{
"id": 928615128,
"route": "/wp-block-editor/v1/navigation-fallback",
"method": "GET",
"is_restricted": false,
"is_inherited": true
},
{
"id": 3759883368,
"route": "/wp/v2/font-collections",
"method": "GET",
"is_restricted": false,
"is_inherited": true
},
{
"id": 3185059763,
"route": "/wp/v2/font-collections/(?p<slug>[\\/\\w-]+)",
"method": "GET",
"is_restricted": false,
"is_inherited": true
}
]
(Premium) Get Access Mode
Fetch the current access mode for the entire RESTful API.
Endpoint
GET /aam/v2/api-routes/mode
Parameters
| Name | Description |
|---|---|
access_level | Required. Can be either "role", "user", "visitor" or "default". |
role_id | Conditionally required if access_level is "role". |
user_id | Conditionally required if access_level is "user". |
Response Sample
{
"mode": "default"
}
(Premium) Set Access Mode
Set the access mode for the entire RESTful API.
Endpoint
POST /aam/v2/api-routes/mode
Parameters
| Name | Description |
|---|---|
access_level | Required. Can be either "role", "user", "visitor" or "default". |
role_id | Conditionally required if access_level is "role". |
user_id | Conditionally required if access_level is "user". |
mode | Optional. The access mode. Can be either "default" or "restricted". If not provided, the "restricted" mode will be set. |
Response Sample
{
"mode": "restricted"
}
Virtual Assistant