Skip to content
GET /v1/describe

Describe a mode

Try it live

10 free calls per day — no sign-up, no API key. Goes through the oanor gateway.

Custom headers (optional)
api.oanor.com/chmod-api

It works. Grab an API key and use it in your project.

Get an API key

Code snippets

curl "https://api.oanor.com/chmod-api/v1/describe" \
  -H "x-oanor-key: oanor_test_..."
await fetch("https://api.oanor.com/chmod-api/v1/describe", {
  headers: { "x-oanor-key": "oanor_test_..." }
});
$ch = curl_init("https://api.oanor.com/chmod-api/v1/describe");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-oanor-key: oanor_test_..."]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);
import requests
requests.get(
    "https://api.oanor.com/chmod-api/v1/describe",
    headers={"x-oanor-key": "oanor_test_..."}
)

Example response

A real response from this endpoint, captured by the latest health check.

{
    "data": {
        "human": "Owner: read, write, execute; Group: read, execute; Others: none",
        "octal": "0750",
        "special": {
            "setgid": false,
            "setuid": false,
            "sticky": false
        },
        "symbolic": "rwxr-x---",
        "octal_short": "750",
        "permissions": {
            "group": {
                "read": true,
                "write": false,
                "execute": true
            },
            "owner": {
                "read": true,
                "write": true,
                "execute": true
            },
            "others": {
                "read": false,
                "write": false,
                "execute": false
            }
        }
    },
    "meta": {
        "timestamp": "2026-06-03T01:09:49.217Z",
        "request_id": "d13836b2-4dea-4dea-b875-a499e48524ff"
    },
    "status": "ok",
    "message": "Describe a mode",
    "success": true
}