Favicon

You are here: Home > API Reference > App Distribution > Application > Validate application slug availability and format

Validate application slug availability and format

Required Permission: mad.application.management.checkSlug

Validates whether a proposed application slug is available for use and meets formatting requirements, checking for uniqueness across published applications and compliance with URL-friendly character restrictions.

GET
/v1/organizations/:organizationId/apps/check-slug/:slug
Copy to clipboard

Validate application slug availability and format

Required Permission: mad.application.management.checkSlug

Validates whether a proposed application slug is available for use and meets formatting requirements, checking for uniqueness across published applications and compliance with URL-friendly character restrictions.

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationId string
required
Unique identifier or URL-friendly slug for the organization that owns the applications to operate on, establishing organizational scope for all nested application operations.
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
slug string
required
URL-friendly unique identifier derived from the application name, used for public-facing store pages, download links, and shareable distribution URLs that end users will interact with.
≤ 128 characters · ≥ 3 characters · Match pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$

Responses

200 Response application/json
status boolean optional
data object optional
valid boolean optional
Boolean indicating whether the proposed slug is available and meets formatting requirements.
reason string optional
Explanation message when slug is invalid, describing the validation failure reason, or empty string when valid.
≤ 256 characters
{
    "status": true,
    "data": {
        "valid": true,
        "reason": ""
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4001
message string optional
Unauthorized
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}