Kutt.it

https://docs.kutt.it
Admin
Kutt.it is an API for a modern URL shortener service, enabling users to create, manage, and track...
Tokens:9,539
Snippets:33
Trust Score:9.6
Update:11 months ago
Show doc for...
Tokens:
Raw
### Get list of links

Source: https://docs.kutt.it/index

Retrieves a list of links. Requires API key authorization. Supports filtering by limit, skip, and an 'all' flag for administrators.

```APIDOC
## GET /api/v2/links

### Description
Retrieves a list of links. Requires API key authorization. Supports filtering by limit, skip, and an 'all' flag for administrators.

### Method
GET

### Endpoint
/api/v2/links

### Parameters
#### Query Parameters
- **limit** (number) - Optional - Limit the number of results returned. Example: `limit=10`
- **skip** (number) - Optional - Skip a certain number of results. Example: `skip=0`
- **all** (boolean) - Optional - Retrieves all links (ADMIN only). Example: `all=false`

### Request Example

### Response
#### Success Response (200)
- **limit** (number) - The number of links returned.
- **skip** (number) - The number of links skipped.
- **total** (number) - The total number of links available.
- **data** (array) - An array of link objects, each containing:
  - **address** (string) - The shortened URL address.
  - **banned** (boolean) - Indicates if the link is banned.
  - **created_at** (string) - The timestamp when the link was created.
  - **id** (string) - The unique identifier for the link.
  - **link** (string) - The original URL.
  - **password** (boolean) - Indicates if the link is password protected.
  - **target** (string) - The original URL.
  - **description** (string) - A description for the link.
  - **updated_at** (string) - The timestamp when the link was last updated.
  - **visit_count** (number) - The number of times the link has been visited.

#### Response Example
```json
{
  "limit": 10,
  "skip": 0,
  "total": 0,
  "data": [
    {
      "address": "string",
      "banned": false,
      "created_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "link": "string",
      "password": false,
      "target": "string",
      "description": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "visit_count": 0
    }
  ]
}
```
```

--------------------------------

### GET /api/v2/users

Source: https://docs.kutt.it/index

Retrieves information about the authenticated user, including their domains.

```APIDOC
## GET /api/v2/users

### Description
Retrieves information about the authenticated user, including their domains.

### Method
GET

### Endpoint
https://kutt.it/api/v2/users

### Response
#### Success Response (200)
- **apikey** (string) - The user's API key.
- **email** (string) - The user's email address.
- **domains** (array) - A list of the user's domains.
  - **address** (string) - The domain address.
  - **banned** (boolean) - Indicates if the domain is banned.
  - **created_at** (string) - The timestamp when the domain was created.
  - **id** (string) - The unique identifier for the domain.
  - **homepage** (string) - The homepage URL of the domain.
  - **updated_at** (string) - The timestamp when the domain was last updated.

#### Response Example
```json
{
  "apikey": "string",
  "email": "string",
  "domains": [
    {
      "address": "string",
      "banned": false,
      "created_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "homepage": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}
```
```

--------------------------------

### Kutt.it API Get User Info Response

Source: https://docs.kutt.it/index

This JSON object details the authenticated user's information, including their API key, email address, and a list of custom domains associated with their account. Each domain object contains its address, banned status, and timestamps.

```JSON
{
  "apikey": "string",
  "email": "string",
  "domains": [
    {
      "address": "string",
      "banned": false,
      "created_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "homepage": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}
```

--------------------------------

### Get link stats

Source: https://docs.kutt.it/index

Retrieves statistics for a specific link, identified by its ID. Requires API key authorization.

```APIDOC
## GET /api/v2/links/{id}/stats

### Description
Retrieves statistics for a specific link, identified by its ID. Requires API key authorization.

### Method
GET

### Endpoint
/api/v2/links/{id}/stats

### Parameters
#### Path Parameters
- **id** (string <uuid>) - Required - The unique identifier of the link to get stats for.

### Request Example

### Response
#### Success Response (200)
- **Link stats** - (Details of the response body for link stats are not fully provided in the input, but typically would include visit counts, referrers, user agents, etc.)

#### Response Example
(Response example for link stats not provided in the input.)
```

--------------------------------

### Create Short Link API Response Sample

Source: https://docs.kutt.it/index

Sample response for the 'Create a short link' endpoint, detailing the structure of a newly created link object. Includes details like address, creation timestamp, ID, and visit count. Requires API key authentication.

```json
{
  "address": "string",
  "banned": false,
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "link": "string",
  "password": false,
  "target": "string",
  "description": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "visit_count": 0

}
```

--------------------------------

### Create a short link

Source: https://docs.kutt.it/index

Creates a new short link. Requires API key authorization. Allows specifying target URL, description, expiry, password, custom URL, reuse, and domain.

```APIDOC
## POST /api/v2/links

### Description
Creates a new short link. Requires API key authorization. Allows specifying target URL, description, expiry, password, custom URL, reuse, and domain.

### Method
POST

### Endpoint
/api/v2/links

### Parameters
#### Request Body
- **target** (string) - Required - The original URL to shorten.
- **description** (string) - Optional - A description for the link.
- **expire_in** (string) - Optional - The expiry time for the link (e.g., "2 minutes", "3 hours", "4 days").
- **password** (string) - Optional - A password to protect the link.
- **customurl** (string) - Optional - A custom path for the shortened URL.
- **reuse** (boolean) - Optional - Whether to reuse an existing short link if the target is the same. Defaults to `false`.
- **domain** (string) - Optional - The custom domain to use for the short link.

### Request Example
```json
{
  "target": "string",
  "description": "string",
  "expire_in": "2 minutes/hours/days",
  "password": "string",
  "customurl": "string",
  "reuse": false,
  "domain": "string"
}
```

### Response
#### Success Response (200)
- **address** (string) - The shortened URL address.
- **banned** (boolean) - Indicates if the link is banned.
- **created_at** (string) - The timestamp when the link was created.
- **id** (string) - The unique identifier for the link.
- **link** (string) - The original URL.
- **password** (boolean) - Indicates if the link is password protected.
- **target** (string) - The original URL.
- **description** (string) - A description for the link.
- **updated_at** (string) - The timestamp when the link was last updated.
- **visit_count** (number) - The number of times the link has been visited.

#### Response Example
```json
{
  "address": "string",
  "banned": false,
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "link": "string",
  "password": false,
  "target": "string",
  "description": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "visit_count": 0
}
```
```

--------------------------------

### POST /api/v2/domains

Source: https://docs.kutt.it/index

Creates a new domain for URL shortening. Requires API key authentication.

```APIDOC
## POST /api/v2/domains

### Description
Creates a new domain for URL shortening. Requires API key authentication.

### Method
POST

### Endpoint
https://kutt.it/api/v2/domains

### Parameters
#### Request Body
- **address** (string) - Required - The domain address.
- **homepage** (string) - Optional - The homepage URL for the domain.

### Request Example
```json
{
  "address": "string",
  "homepage": "string"
}
```

### Response
#### Success Response (200)
- **address** (string) - The created domain address.
- **banned** (boolean) - Indicates if the domain is banned.
- **created_at** (string) - The timestamp when the domain was created.
- **id** (string) - The unique identifier for the domain.
- **homepage** (string) - The homepage URL of the domain.
- **updated_at** (string) - The timestamp when the domain was last updated.

#### Response Example
```json
{
  "address": "string",
  "banned": false,
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "homepage": "string",
  "updated_at": "2019-08-24T14:15:22Z"
}
```
```

--------------------------------

### List Links API Endpoint

Source: https://docs.kutt.it/index

Retrieves a list of links. Supports pagination with 'limit' and 'skip' query parameters. An 'all' parameter is available for administrators to view all links. Requires API key authentication.

```json
{
  "limit": 10,
  "skip": 0,
  "total": 0,
  "data": [
    {
      "address": "string",
      "banned": false,
      "created_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "link": "string",
      "password": false,
      "target": "string",
      "description": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "visit_count": 0
}
]

}
```

--------------------------------

### Create Short Link API Request Payload

Source: https://docs.kutt.it/index

Creates a new short link. Requires the 'target' URL and optionally accepts 'description', 'expire_in', 'password', 'customurl', 'reuse', and 'domain'. Authentication is via API key.

```json
{
  "target": "string",
  "description": "string",
  "expire_in": "2 minutes/hours/days",
  "password": "string",
  "customurl": "string",
  "reuse": false,
  "domain": "string"

}
```

--------------------------------

### Kutt.it API Create Domain Request

Source: https://docs.kutt.it/index

This JSON payload is used to create a new custom domain in Kutt.it. It requires the 'address' of the domain and optionally accepts a 'homepage' URL. The API returns the created domain details upon success.

```JSON
{
  "address": "string",
  "homepage": "string"
}
```

--------------------------------

### Kutt.it API Create Domain Response

Source: https://docs.kutt.it/index

This JSON structure represents the response after successfully creating a custom domain in Kutt.it. It includes the domain's address, its banned status, creation and update timestamps, and a unique identifier.

```JSON
{
  "address": "string",
  "banned": false,
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "homepage": "string",
  "updated_at": "2019-08-24T14:15:22Z"
}
```

--------------------------------

### Kutt.it API Response Structure

Source: https://docs.kutt.it/index

This JSON structure represents a typical response from the Kutt.it API, detailing statistics for different time periods (last day, week, month, year), link information, and creation/update timestamps. It includes browser, OS, country, and referrer statistics.

```JSON
{
  "lastDay": {
    "stats": {
      "browser": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "os": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "country": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "referrer": [
        {
          "name": "string",
          "value": 0
        }
      ]
    },
    "views": [
      0
    ]
  },
  "lastMonth": {
    "stats": {
      "browser": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "os": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "country": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "referrer": [
        {
          "name": "string",
          "value": 0
        }
      ]
    },
    "views": [
      0
    ]
  },
  "lastWeek": {
    "stats": {
      "browser": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "os": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "country": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "referrer": [
        {
          "name": "string",
          "value": 0
        }
      ]
    },
    "views": [
      0
    ]
  },
  "lastYear": {
    "stats": {
      "browser": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "os": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "country": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "referrer": [
        {
          "name": "string",
          "value": 0
        }
      ]
    },
    "views": [
      0
    ]
  },
  "updatedAt": "string",
  "address": "string",
  "banned": false,
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "link": "string",
  "password": false,
  "target": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "visit_count": 0
}
```

--------------------------------

### Delete Link API Response Sample

Source: https://docs.kutt.it/index

Sample response for the 'Delete a link' endpoint, confirming successful deletion with a message. Requires the link ID as a path parameter and API key authentication.

```json
{
  "message": "string"

}
```

--------------------------------

### Update a link

Source: https://docs.kutt.it/index

Updates an existing link identified by its ID. Requires API key authorization. Allows modification of target URL, address, description, and expiry.

```APIDOC
## PATCH /api/v2/links/{id}

### Description
Updates an existing link identified by its ID. Requires API key authorization. Allows modification of target URL, address, description, and expiry.

### Method
PATCH

### Endpoint
/api/v2/links/{id}

### Parameters
#### Path Parameters
- **id** (string <uuid>) - Required - The unique identifier of the link to update.

#### Request Body
- **target** (string) - Required - The original URL to shorten.
- **address** (string) - Required - The shortened URL address.
- **description** (string) - Optional - A description for the link.
- **expire_in** (string) - Optional - The expiry time for the link (e.g., "2 minutes", "3 hours", "4 days").

### Request Example
```json
{
  "target": "string",
  "address": "string",
  "description": "string",
  "expire_in": "2 minutes/hours/days"
}
```

### Response
#### Success Response (200)
- **address** (string) - The shortened URL address.
- **banned** (boolean) - Indicates if the link is banned.
- **created_at** (string) - The timestamp when the link was created.
- **id** (string) - The unique identifier for the link.
- **link** (string) - The original URL.
- **password** (boolean) - Indicates if the link is password protected.
- **target** (string) - The original URL.
- **description** (string) - A description for the link.
- **updated_at** (string) - The timestamp when the link was last updated.
- **visit_count** (number) - The number of times the link has been visited.

#### Response Example
```json
{
  "address": "string",
  "banned": false,
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "link": "string",
  "password": false,
  "target": "string",
  "description": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "visit_count": 0
}
```
```

--------------------------------

### DELETE /api/v2/domains/{id}

Source: https://docs.kutt.it/index

Deletes a specified domain. Requires API key authentication.

```APIDOC
## DELETE /api/v2/domains/{id}

### Description
Deletes a specified domain. Requires API key authentication.

### Method
DELETE

### Endpoint
https://kutt.it/api/v2/domains/{id}

### Parameters
#### Path Parameters
- **id** (string <uuid>) - Required - The unique identifier of the domain to delete.

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating successful deletion.

#### Response Example
```json
{
  "message": "string"
}
```
```

--------------------------------

### API Health

Source: https://docs.kutt.it/index

Checks the health status of the Kutt.it API.

```APIDOC
## GET /api/v2/health

### Description
Checks the health status of the Kutt.it API.

### Method
GET

### Endpoint
/api/v2/health

### Parameters

### Request Example

### Response
#### Success Response (200)
- **Response Body**: "OK"

#### Response Example
```
OK
```
```

--------------------------------

### Kutt.it API Delete Domain Response

Source: https://docs.kutt.it/index

A simple success message returned by the Kutt.it API after a domain has been successfully deleted. This indicates the operation was completed without issues.

```JSON
{
  "message": "string"
}
```

--------------------------------

### API Health Check

Source: https://docs.kutt.it/index

This endpoint checks the health status of the Kutt.it API. It returns a simple 'OK' message upon successful communication. No specific inputs are required, and the response is typically text/html.

```html
OK
```

--------------------------------

### Delete a link

Source: https://docs.kutt.it/index

Deletes a specific link by its ID. Requires API key authorization.

```APIDOC
## DELETE /api/v2/links/{id}

### Description
Deletes a specific link by its ID. Requires API key authorization.

### Method
DELETE

### Endpoint
/api/v2/links/{id}

### Parameters
#### Path Parameters
- **id** (string <uuid>) - Required - The unique identifier of the link to delete.

### Request Example

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of successful deletion.

#### Response Example
```json
{
  "message": "string"
}
```
```

--------------------------------

### Update Link API Request Payload

Source: https://docs.kutt.it/index

Payload for the 'Update a link' endpoint. Requires the link 'id' in the path and allows updating 'target', 'address', 'description', and 'expire_in' in the request body. Requires API key authentication.

```json
{
  "target": "string",
  "address": "string",
  "description": "string",
  "expire_in": "2 minutes/hours/days"

}
```
Tokens:
Raw