Fumadocs

Get a planet

GET
/planets/{planetId}

You'll better learn a little bit more about the planets. It might come in handy once space travel is available for everyone.

Path Parameters

planetId*integer

The ID of the planet to get

Response Body

curl -X GET "https://example.com/planets/1"
{  "id": 1,  "name": "Mars",  "description": "The red planet",  "type": "terrestrial",  "habitabilityIndex": 0.68,  "physicalProperties": {    "mass": 0.107,    "radius": 0.532,    "gravity": 0.378,    "temperature": {      "min": 130,      "max": 308,      "average": 210,      "temperatureMetric1": 0.1,      "temperatureMetric2": 0.1    },    "measurement1": 0.1,    "measurement2": 0.1  },  "atmosphere": [    {      "compound": "CO2",      "percentage": 95.3,      "atmosphericData1": "string",      "atmosphericData2": "string"    }  ],  "discoveredAt": "1610-01-07T00:00:00Z",  "image": "https://cdn.scalar.com/photos/mars.jpg",  "satellites": [    {      "id": 1,      "name": "Phobos",      "description": "Phobos is the larger and innermost of the two moons of Mars.",      "diameter": 22.2,      "type": "moon",      "orbit": {        "planet": {          "id": 1,          "name": "Mars",          "description": "The red planet",          "type": "terrestrial",          "habitabilityIndex": 0.68,          "physicalProperties": {            "mass": 0.107,            "radius": 0.532,            "gravity": 0.378,            "temperature": {              "min": 130,              "max": 308,              "average": 210,              "temperatureMetric1": 0.1,              "temperatureMetric2": 0.1            },            "measurement1": 0.1,            "measurement2": 0.1          },          "atmosphere": [            {              "compound": "CO2",              "percentage": 95.3,              "atmosphericData1": "string",              "atmosphericData2": "string"            }          ],          "discoveredAt": "1610-01-07T00:00:00Z",          "image": "https://cdn.scalar.com/photos/mars.jpg",          "satellites": [],          "creator": {            "id": 1,            "name": "Marc"          },          "tags": [            "solar-system",            "rocky",            "explored"          ],          "lastUpdated": "2024-01-15T14:30:00Z",          "successCallbackUrl": "https://example.com/webhook",          "failureCallbackUrl": "https://example.com/webhook"        },        "orbitalPeriod": 0.319,        "distance": 9376      }    }  ],  "creator": {    "id": 1,    "name": "Marc"  },  "tags": [    "solar-system",    "rocky",    "explored"  ],  "lastUpdated": "2024-01-15T14:30:00Z",  "successCallbackUrl": "https://example.com/webhook",  "failureCallbackUrl": "https://example.com/webhook"}
{  "type": "https://example.com/errors/not-found",  "title": "Not Found",  "status": 404,  "detail": "The resource you are trying to access does not exist."}

Create a planet POST

Time to play god and create a new planet. What do you think? Ah, don't think too much. What could go wrong anyway?

Delete a planet DELETE

This endpoint was used to delete planets. Unfortunately, that caused a lot of trouble for planets with life. So, this endpoint is now deprecated and should not be used anymore.