API docs by Redocly

DyLy Project API (v1)

Download OpenAPI specification:

DyLy Project API

projects

delete project

Permanently deletes a project and all associated resources including domains, API keys, and short links. This operation cannot be undone.

Behavior

  • All custom domains associated with the project are removed
  • All API keys (primary and secondary) are revoked
  • All short links created under this project are deleted
  • The operation is idempotent - calling delete on an already deleted project returns 404

Rate limiting

  • Subject to rate limiting based on the user's plan
path Parameters
project_id
required
string <uuid> = 36 characters
Example: 11111111-1111-1111-1111-111111111111

The unique identifier (UUID v4) of the project to delete. Must be a valid UUID format.

header Parameters
Authorization
required
string
Example: Basic YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo6MTIzNDU2Nzg5MA==

HTTP Basic authentication header. Format: Authorization: Basic base64(clientId:clientSecret) where clientId and clientSecret are the API credentials that have permission to delete the project.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_PARAMETER",
  • "errorMessage": "The provided project_id does not match the required UUID format",
  • "correlationId": "33333333-3333-3333-3333-333333333333"
}

get project

Retrieves detailed information about a specific project including its configuration, domains, and plan details.

Response

  • Returns project metadata including projectId, name, registered domains, and active plan
  • Domain list includes the default subdomain and any custom domains

Rate limiting

  • Subject to rate limiting based on the user's plan
path Parameters
project_id
required
string <uuid> = 36 characters
Example: 11111111-1111-1111-1111-111111111111

The unique identifier (UUID v4) of the project to retrieve. Must be a valid UUID format.

header Parameters
Authorization
required
string
Example: Basic YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo6MTIzNDU2Nzg5MA==

HTTP Basic authentication header. Format: Authorization: Basic base64(clientId:clientSecret) where clientId and clientSecret are the API credentials that have read permission for the project.

Responses

Response samples

Content type
application/json
{
  • "projectId": "11111111-1111-1111-1111-111111111111",
  • "name": "MyProject",
  • "domains": [
    ],
  • "plan": "Free",
  • "fallbackUrl": "https://example.com/404"
}

update project

Updates the configuration of an existing project. Allows modification of project name and fallback URL settings.

Updatable fields

  • name: The display name of the project
  • fallbackUrl: Optional URL to redirect users when a short link is not found or expired

Validation

  • Project name must follow the naming pattern (start with letter, alphanumeric with spaces/hyphens/underscores, 1-32 characters)
  • Fallback URL must be a valid absolute HTTP(S) URL if provided
  • Empty request body is accepted (no fields will be updated)

Rate limiting

  • Subject to rate limiting based on the user's plan
path Parameters
project_id
required
string <uuid> = 36 characters
Example: 11111111-1111-1111-1111-111111111111

The unique identifier (UUID v4) of the project to update. Must be a valid UUID format.

header Parameters
Authorization
required
string
Example: Basic YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo6MTIzNDU2Nzg5MA==

HTTP Basic authentication header. Format: Authorization: Basic base64(clientId:clientSecret) where clientId and clientSecret are the API credentials that have update permission for the project.

Request Body schema: application/json
optional

Project update parameters. All fields are optional. Only provided fields will be updated.

name
string [ 1 .. 32 ] characters

The display name of the project. Must start with a letter, followed by letters, digits, spaces, hyphens, or underscores, and end with a letter or digit. Length: 1-32 characters.

fallbackUrl
string [ 1 .. 1024 ] characters

Optional fallback URL where users are redirected when a short link is not found, expired, or one-time link has already been used. Must be a valid absolute HTTP or HTTPS URL.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "projectId": "11111111-1111-1111-1111-111111111111",
  • "name": "MyProject",
  • "domains": [
    ],
  • "plan": "Free",
  • "fallbackUrl": "https://example.com/404"
}