ursh - URL Shortener (2.0)

Download OpenAPI specification:Download

public

shows a message or redirects to a configured url

Responses

responds with the allowed HTTP methods

Responses

redirects to the URL registered for the given shortcut

path Parameters

shortcut

required

any

a previously generated or manually created shortcut

Responses

responds with the allowed HTTP methods

path Parameters

shortcut

required

any

a previously generated or manually created shortcut

Responses

admins

deletes an existing token

Delete an existing API token.

path Parameters

api_key

required

any

the API key of the token to delete

header Parameters

Authorization

required

any

the API key bearer

Responses

returns one or more tokens

Obtain the API tokens that match the given parameters. If api_key is provided, then exactly one token will be returned. Otherwise, a collection of tokens that match the provided parameters will be returned (maybe empty).

path Parameters

api_key

required

any

the API key of the token to obtain - may be omitted

header Parameters

Authorization

required

any

the API key bearer

Responses

modifies an existing token

Modify the properties of an existing API token.

path Parameters

api_key

required

any

the API key of the token to modify

header Parameters

Authorization

required

any

the API key bearer

Responses

creates a new token

Create a new API token for communicating with the API.

header Parameters

Authorization

required

any

the API key bearer

Responses

deletes an existing URL object

Delete an existing URL object

path Parameters

shortcut

required

any

the shortcut of the URL object to delete

header Parameters

Authorization

required

any

the API key bearer

Responses

returns one or more URL objects

Obtain the URLs that match the given parameters. If shortcut is provided, then exactly one URL will be returned. Otherwise, a collection of tokens that match the provided parameters will be returned (maybe empty). Non-admin users may only obtain their own URLs (created with their API key).

path Parameters

shortcut

required

any

the shortcut of the URL to obtain - may be omitted

header Parameters

Authorization

required

any

the API key bearer

Responses

modify an existing URL

Modify the properties of an existing URL object. Non-admin users may only patch their own URLs (created with their API key).

path Parameters

shortcut

required

any

the shortcut of the URL object to patch

header Parameters

Authorization

required

any

the API key bearer

Responses

generates a new URL shortcut

Create a (new) shortcut for the given URL.

header Parameters

Authorization

required

any

the API key bearer

Responses

creates a manually specified URL shortcut

Manually create a URL shortcut.

path Parameters

shortcut

required

any

the shortcut of the URL to put

header Parameters

Authorization

required

any

the API key bearer

Responses

users

responds with the allowed HTTP methods

header Parameters

Authorization

required

any

the API key bearer

Responses

deletes an existing URL object

Delete an existing URL object

path Parameters

shortcut

required

any

the shortcut of the URL object to delete

header Parameters

Authorization

required

any

the API key bearer

Responses

returns one or more URL objects

Obtain the URLs that match the given parameters. If shortcut is provided, then exactly one URL will be returned. Otherwise, a collection of tokens that match the provided parameters will be returned (maybe empty). Non-admin users may only obtain their own URLs (created with their API key).

path Parameters

shortcut

required

any

the shortcut of the URL to obtain - may be omitted

header Parameters

Authorization

required

any

the API key bearer

Responses

responds with the allowed HTTP methods

header Parameters

Authorization

required

any

the API key bearer

Responses

modify an existing URL

Modify the properties of an existing URL object. Non-admin users may only patch their own URLs (created with their API key).

path Parameters

shortcut

required

any

the shortcut of the URL object to patch

header Parameters

Authorization

required

any

the API key bearer

Responses

generates a new URL shortcut

Create a (new) shortcut for the given URL.

header Parameters

Authorization

required

any

the API key bearer

Responses

creates a manually specified URL shortcut

Manually create a URL shortcut.

path Parameters

shortcut

required

any

the shortcut of the URL to put

header Parameters

Authorization

required

any

the API key bearer