Showcase and feedback: command-line interface to work with roblox APIs

Resources Community Resources
, ,
#1

Hello! Myself and a few folks have been building a command-line interface that can modify resources exposed by Roblox’s cloud v2 APIs. I was curious to see if it’s helpful to others, and interested in suggestions.

Basically, you can do stuff like get or update the user, universe, or anything exposed by the cloud v2 api:

aepcli roblox universe get 5095556805
{
  "path": "universes/5095556805",
  "createTime": "2023-09-15T22:13:54.357Z",
  "updateTime": "2023-09-15T22:13:54.453Z",
  "displayName": "obsnuffles's Place",
  "description": "This is your very first Roblox creation. Check it out, then make it your own with Roblox Studio!",
  "user": "users/5033986153",
  "visibility": "PUBLIC",
  "voiceChatEnabled": false,
  "ageRating": "AGE_RATING_UNSPECIFIED",
  "desktopEnabled": true,
  "mobileEnabled": false,
  "tabletEnabled": false,
  "consoleEnabled": false,
  "vrEnabled": true
}

aepcli roblox data-store-entry --universe=5095556805 --data-store=fod create baz --attributes='{"x": "y"}' --value='{"a":"b"}'
{
  "path": "universes/5095556805/data-stores/fod/entries/baz",
  "createTime": "2024-11-14T21:03:54.365943800Z",
  "revisionId": "08DD04EFD92B2FAE.0000000001.08DD04EFD92B2FAE.01",
  "revisionCreateTime": "2024-11-14T21:03:54.365943800Z",
  "state": "ACTIVE",
  "etag": "08DD04EFD92B2FAE.0000000001.08DD04EFD92B2FAE.01",
  "value": {
    "a": "b"
  },
  "id": "baz",
  "attributes": {
    "x": "y"
  }
}

Or any of the resources here:

aepcli roblox
2024/11/14 13:04:52 WARN resource "/groups/{group}/shout" has a LIST method with a response schema, but the items field is not present or is not an array.
Usage: [resource] [method] [flags]

Command group for https://apis.roblox.com/cloud/v2

Available resources:
  - creator-store-product
  - data-store
  - data-store-entry
  - group
  - group-join-request
  - group-membership
  - group-role
  - inventory-item
  - luau-execution-session-task
  - luau-execution-session-task-log
  - operation
  - ordered-data-store-entry
  - place
  - subscription
  - universe
  - user
  - user-notification
  - user-restriction

The project itself is called aepcli, and it’s designed to work with APIs that are compliant with the guidance in aep.dev. But Roblox APIs are very close, so I tried to see if it would work, and it did! It grabs the api documentation from

If anyone has had a need to go look at these resources in an easy fashion, I’d love to have people try it out.

Here are some link to learn more:

1 Like
#2

(you should probably move this to #help-and-feedback:creations-feedback before a mod comes)

#3

Thanks! I guess this is more “resources” - so let me move it there.

#4

Also for some reason I get a 403 for updates, but just to fill in some blanks:

The client is dynamically generated: it reads the openapi definition and generates the client for you. So when the openapi is updated, this client will also support those resources.

The rest API documentation is from raw.githubusercontent.com/Roblox/creator-docs/refs/heads/main/content/en-us/reference/cloud/cloud.docs.json.

#5

That’s actually so nice. I’ll definitely using this soon. Thanks!