Cyber Asset Management API

This API manages a database of cyber assets, such as networking equipment, servers, personal computers, etc.

Prerequisites

Before running the API, ensure you have the following installed:

• Python 3.x
• Flask
• Flask-Restful
• SQLite3

Installation

1. Clone the repository to your local machine:

   git clone https://github.com/C02022/cyber-asset-management-api.git

2. Navigate to the project directory:

   cd cyber-asset-management-api

3. Create a virtual environment (optional but recommended):

   python -m venv venv

4. Activate the virtual environment:

   • On Windows:

     venv\Scripts\activate

   • On macOS/Linux:

     source venv/bin/activate

5. Install the required dependencies:

   pip install -r requirements.txt

Usage

1. Start the API server and intialize the SQLite database:

   python server.py

2. The API will be accessible at http://localhost:5000.

Endpoints

GET /assets

• Returns a list of all cyber assets in the database.

  Query Parameters:

  • type: Filter assets by type.

  Example:

  GET /assets?type=Laptop
  

POST /assets

• Adds a new cyber asset to the database.

  Request Body (JSON):

  {
      "NAME": "Asset Name",
      "TYPE": "Asset Type",
      "SERIAL_NUMBER": "ABC123",
      "OPERATING_SYSTEM": "Windows"
  }

GET /assets/{id}

• Returns details of a specific cyber asset by ID.

  Example:

  GET /assets/1
  

PUT /assets/{id}

• Updates details of a specific asset by ID.

  Request Body (JSON):

  {
      "NAME": "Updated Asset Name",
      "TYPE": "Updated Asset Type",
      "SERIAL_NUMBER": "XYZ789",
      "OPERATING_SYSTEM": "Linux"
  }

DELETE /assets/{id}

• Deletes a specific asset by ID.

  Example:

  DELETE /assets/1
  

Testing

You can test the API using tools like Postman or by making HTTP requests from your code. Here are some sample requests:

1. Create a new asset:

   POST /assets
   Request Body:
   {
       "NAME": "Asset Name",
       "TYPE": "Asset Type",
       "SERIAL_NUMBER": "ABC123",
       "OPERATING_SYSTEM": "Windows"
   }
   

2. Retrieve all assets:

   GET /assets
   

3. Retrieve assets filtered by type:

   GET /assets?type=Router
   

4. Update an asset:

   PUT /assets/1
   Request Body:
   {
       "NAME": "Updated Asset Name",
       "TYPE": "Updated Asset Type",
       "SERIAL_NUMBER": "XYZ789",
       "OPERATING_SYSTEM": "Linux"
   }
   

5. Delete an asset:

   DELETE /assets/1
   

Contributors

• Christopher Obando

---