QRcodly
APIShort url

Create a standalone short URL

Creates a new standalone short URL (not linked to a QR code). A unique 5-character short code is automatically generated. Optionally assign a custom domain and set the active state.

POST
/short-url

Authorization

bearerAuth
AuthorizationBearer <token>

Authenticate with a Bearer token. Pass your API key in the Authorization header: Authorization: Bearer <your-api-key>

In: header

Request Body

application/json

destinationUrl*string

The destination URL to redirect to (must start with http:// or https://)

Formaturi
isActive*boolean

Whether the short URL should be active immediately (default: true)

Defaulttrue
customDomainId*|

ID of the custom domain used for this short URL, or null for the default domain

Defaultnull
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
name*|

User-defined name for the short URL (max 50 characters)

Defaultnull
Lengthlength <= 50
[key: string]?never

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.qrcodly.de/api/v1/short-url" \  -H "Content-Type: application/json" \  -d '{    "destinationUrl": "http://example.com",    "isActive": true,    "customDomainId": null,    "name": null  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "shortCode": "strin",
  "name": null,
  "destinationUrl": "http://example.com",
  "qrCodeId": "8a619d64-dbe8-4c9d-9490-babe22a53a28",
  "isActive": true,
  "createdBy": "string",
  "deletedAt": null,
  "customDomain": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "domain": "string",
    "isDefault": true,
    "isEnabled": true,
    "createdBy": "string",
    "verificationPhase": "dns_verification",
    "ownershipTxtVerified": true,
    "cnameVerified": true,
    "cloudflareHostnameId": "string",
    "sslStatus": "initializing",
    "ownershipStatus": "pending",
    "sslValidationRecord": {
      "name": "string",
      "value": "string"
    },
    "ownershipValidationRecord": {
      "name": "string",
      "value": "string"
    },
    "validationErrors": [
      "string"
    ]
  },
  "tags": []
}
{
  "message": "string",
  "code": 0,
  "fieldErrors": {
    "property1": null,
    "property2": null
  }
}
{
  "message": "string",
  "code": 0
}
{
  "message": "string",
  "code": 0
}