ReadMe
Developer toolsAPI key
ReadMe is a developer documentation platform. Manage versions, categories, and docs and search documentation.
31 actions
| Action | Effect | Data handled | Scope |
|---|---|---|---|
| readme_get_projectGet metadata for the ReadMe project associated with the API key | read | General | |
| readme_list_versionsList the versions configured for the ReadMe project | read | General | |
| readme_get_versionGet one ReadMe project version by semver identifier | read | General | |
| readme_create_versionCreate a new ReadMe project version from an existing base version | write | General | |
| readme_update_versionUpdate one ReadMe project version by semver identifier | write | General | |
| readme_delete_versionDelete one ReadMe project version by semver identifier | destructive | General | |
| readme_list_categoriesList ReadMe guide and reference categories with optional version and pagination | read | General | |
| readme_create_categoryCreate a ReadMe guide or reference category | write | General | |
| readme_get_categoryGet one ReadMe category by slug | read | General | |
| readme_update_categoryUpdate one ReadMe category by slug | write | General | |
| readme_delete_categoryDelete one ReadMe category by slug | destructive | General | |
| readme_list_category_docsList the ReadMe docs that belong to a category slug | read | General | |
| readme_search_docsSearch ReadMe docs by text query | write | General | |
| readme_get_docGet one ReadMe doc by slug, optionally requesting the production doc version | read | General | |
| readme_update_docUpdate one ReadMe doc page by slug | write | General | |
| readme_delete_docDelete one ReadMe doc page by slug | destructive | General | |
| readme_list_custom_pagesList ReadMe custom pages with optional pagination | read | General | |
| readme_create_custom_pageCreate a ReadMe custom page | write | General | |
| readme_get_custom_pageGet one ReadMe custom page by slug | read | General | |
| readme_update_custom_pageUpdate one ReadMe custom page by slug | write | General | |
| readme_delete_custom_pageDelete one ReadMe custom page by slug | destructive | General | |
| readme_list_changelogsList ReadMe changelog entries with optional pagination | read | General | |
| readme_create_changelogCreate a ReadMe changelog entry | write | General | |
| readme_get_changelogGet one ReadMe changelog entry by slug | read | General | |
| readme_update_changelogUpdate one ReadMe changelog entry by slug | write | General | |
| readme_delete_changelogDelete one ReadMe changelog entry by slug | destructive | General | |
| readme_list_api_specificationsList ReadMe API specification metadata with optional version and pagination | read | General | |
| readme_delete_api_specificationDelete one ReadMe API specification by ID | destructive | General | |
| readme_get_api_registryRetrieve one ReadMe API Registry entry by UUID | read | General | |
| readme_get_openapi_schemaGet the OpenAPI definition for the ReadMe project | read | General | |
| readme_list_outbound_ipsList ReadMe outbound IP addresses used for webhook and Try It proxy requests | read | General |