Instruction Endpoints

GET /instructions

Returns a list of all instructions.

Parameters

Name	Type	Location	Required	Description
limit	integer	query	No	The maximum number of instructions to return. The default and maximum is 50
offset	integer	query	No	The offset to start from. The default is 0

Example Requests

cURL

curl -X GET \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/instructions

JS Fetch

fetch('https://alekeagle.me/api/instructions', {
  method: 'GET',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

• 200 OK
  • List<Instruction>
• 401 Unauthorized
  • InvalidSession
• 403 Forbidden
  • Banned
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal
• 503 Service Unavailable
  • ServiceUnavailable

GET /instructions/:id

Returns a single instruction.

Parameters

Name	Type	Location	Required	Description
id	string	path	Yes	The ID

Example Requests

cURL

curl -X GET \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/instructions/generic-service

JS Fetch

fetch('https://alekeagle.me/api/instructions/generic-service', {
  method: 'GET',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

• 200 OK
  • Instruction
• 401 Unauthorized
  • InvalidSession
• 403 Forbidden
  • Banned
• 404 Not Found
  • InvalidInstruction
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal
• 503 Service Unavailable
  • ServiceUnavailable

POST /instructions

Creates a new instruction.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Parameters

Name	Type	Location	Required	Description
id	string	body	Yes	The ID
name	string	body	Yes	The display name
description	string	body	Yes	The description
filename	string	body	No	The filename
content	string	body	Yes	The file content
steps	string[]	body	Yes	The steps

Example Requests

cURL

curl -X POST \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"id":"generic-service","name":"Generic Service","description":"A generic service","filename":"generic-service.sh","content":"#!/bin/bash\necho \"Hello, World!\"","steps":["Click me to download the configuration file!", "Run the file provided."]}' \
https://alekeagle.me/api/instructions

JS Fetch

fetch('https://alekeagle.me/api/instructions', {
  method: 'POST',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    id: 'generic-service',
    name: 'Generic Service',
    description: 'A generic service',
    filename: 'generic-service.sh',
    content: '#!/bin/bash\necho "Hello, World!"',
    steps: [
      'Click me to download the configuration file!',
      'Run the file provided.',
    ],
  }),
});

Responses

• 201 Created
  • Instruction
• 400 Bad Request
  • MissingFields
  • InvalidInstruction
• 401 Unauthorized
  • InvalidSession
• 403 Forbidden
  • Banned
  • InsufficientPermissions
• 409 Conflict
  • InstructionExists
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal
• 503 Service Unavailable
  • ServiceUnavailable

PUT /instructions/:id/name

Updates the name of an instruction.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Parameters

Name	Type	Location	Required	Description
id	string	path	Yes	The ID
name	string	body	Yes	The name

Example Requests

cURL

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"name":"Generic Service"}' \
https://alekeagle.me/api/instructions/generic-service/name

JS Fetch

fetch('https://alekeagle.me/api/instructions/generic-service/name', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Generic Service',
  }),
});

Responses

• 200 OK
  • Instruction
• 400 Bad Request
  • MissingFields
  • InvalidInstruction
• 401 Unauthorized
  • InvalidSession
• 403 Forbidden
  • Banned
  • InsufficientPermissions
• 404 Not Found
  • InvalidInstruction
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal
• 503 Service Unavailable
  • ServiceUnavailable

PUT /instructions/:id/description

Updates the description of an instruction.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Parameters

Name	Type	Location	Required	Description
id	string	path	Yes	The ID
description	string	body	Yes	The description

Example Requests

cURL

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"description":"A generic service"}' \
https://alekeagle.me/api/instructions/generic-service/description

JS Fetch

fetch('https://alekeagle.me/api/instructions/generic-service/description', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    description: 'A generic service',
  }),
});

Responses

• 200 OK
  • Instruction
• 400 Bad Request
  • MissingFields
• 401 Unauthorized
  • InvalidSession
• 403 Forbidden
  • Banned
  • InsufficientPermissions
• 404 Not Found
  • InvalidInstruction
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal
• 503 Service Unavailable
  • ServiceUnavailable

PUT /instructions/:id/file

Updates the file of an instruction.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Parameters

Name	Type	Location	Required	Description
id	string	path	Yes	The ID
filename	string	body	No	The filename. Omit to specify clipboard content
content	string	body	Yes	The content

Example Requests

cURL

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"filename":"index.js","content":"console.log(\"Hello, world!\");"}' \
https://alekeagle.me/api/instructions/generic-service/file

JS Fetch

fetch('https://alekeagle.me/api/instructions/generic-service/file', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filename: 'index.js',
    content: 'console.log("Hello, world!");',
  }),
});

Responses

• 200 OK
  • Instruction
• 400 Bad Request
  • MissingFields
• 401 Unauthorized
  • InvalidSession
• 403 Forbidden
  • Banned
  • InsufficientPermissions
• 404 Not Found
  • InvalidInstruction
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal
• 503 Service Unavailable
  • ServiceUnavailable

PUT /instructions/:id/steps

Updates the steps of an instruction.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Parameters

Name	Type	Location	Required	Description
id	string	path	Yes	The ID
steps	string[]	body	Yes	The steps

Example Requests

cURL

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"steps":["Step 1","Step 2","Step 3"]}' \
https://alekeagle.me/api/instructions/generic-service/steps

JS Fetch

fetch('https://alekeagle.me/api/instructions/generic-service/steps', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    steps: ['Step 1', 'Step 2', 'Step 3'],
  }),
});

Responses

• 200 OK
  • Instruction
• 400 Bad Request
  • MissingFields
• 401 Unauthorized
  • InvalidSession
• 403 Forbidden
  • Banned
  • InsufficientPermissions
• 404 Not Found
  • InvalidInstruction
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal
• 503 Service Unavailable
  • ServiceUnavailable

DELETE /api/instructions/:id

Deletes an instruction.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Parameters

Name	Type	Location	Required	Description
id	string	path	Yes	The ID

Example Requests

cURL

curl -X DELETE \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/instructions/generic-service

JS Fetch

fetch('https://alekeagle.me/api/instructions/generic-service', {
  method: 'DELETE',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

• 200 OK
  • DeleteInstruction
• 401 Unauthorized
  • InvalidSession
• 403 Forbidden
  • Banned
  • InsufficientPermissions
• 404 Not Found
  • InvalidInstruction
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal
• 503 Service Unavailable
  • ServiceUnavailable

DELETE /api/instructions

Deletes multiple instructions.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Parameters

Name	Type	Location	Required	Description
ids	string	body	Yes	The IDs

Example Requests

cURL

curl -X DELETE \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"ids": ["generic-service", "generic-service-2"]}' \
https://alekeagle.me/api/instructions

JS Fetch

fetch('https://alekeagle.me/api/instructions', {
  method: 'DELETE',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ ids: ['generic-service', 'generic-service-2'] }),
});

Responses

• 200 OK
  • DeleteInstructions
• 400 Bad Request
  • MissingFields
• 401 Unauthorized
  • InvalidSession
• 403 Forbidden
  • Banned
  • InsufficientPermissions
• 404 Not Found
  • InvalidInstruction
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal
• 503 Service Unavailable
  • ServiceUnavailable