Documentation for mongocamp-server

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AdminApi	addRole	PUT /admin/roles	Add Role
AdminApi	addUser	PUT /admin/users	Add User
AdminApi	deleteRole	DELETE /admin/roles/	Delete Role
AdminApi	deleteUser	DELETE /admin/users/	Delete User
AdminApi	getRole	GET /admin/roles/	Get Role
AdminApi	getUser	GET /admin/users/	UserProfile for userId
AdminApi	gnerateNewApiKeyForUser	PATCH /admin/users/{userId}/apikey	Update ApiKey
AdminApi	listRoles	GET /admin/roles	List Roles
AdminApi	listUsers	GET /admin/users	List Users
AdminApi	updatePasswordForUser	PATCH /admin/users/{userId}/password	Update Password
AdminApi	updateRole	PATCH /admin/roles/	Update Role
AdminApi	updateRolesForUser	PATCH /admin/users/{userId}/roles	Update User Roles
ApplicationApi	eventMetrics	GET /system/monitoring/events	Event Metrics
ApplicationApi	getConfig	GET /system/configurations/	Configuration for configurationKey
ApplicationApi	jvmMetrics	GET /system/monitoring/jvm	JVM Metrics
ApplicationApi	listConfigurations	GET /system/configurations	List Configurations
ApplicationApi	mongoDbMetrics	GET /system/monitoring/mongodb	MongoDb Metrics
ApplicationApi	settings	GET /system/settings	System Settings
ApplicationApi	systemMetrics	GET /system/monitoring/system	System Metrics
ApplicationApi	updateConfiguration	PATCH /system/configurations/	Update Configuration
AuthApi	generateNewApiKey	PATCH /auth/profile/apikey	Update ApiKey
AuthApi	isAuthenticated	GET /auth/authenticated	Check Authentication
AuthApi	login	POST /auth/login	Login User
AuthApi	logout	POST /auth/logout	Logout User
AuthApi	logoutByDelete	DELETE /auth/logout	Logout User
AuthApi	refreshToken	GET /auth/token/refresh	Refresh User
AuthApi	updatePassword	PATCH /auth/profile/password	Update Password
AuthApi	userProfile	GET /auth/profile	User Profile
BucketApi	clearBucket	DELETE /mongodb/buckets/{bucketName}/clear	Clear Bucket
BucketApi	deleteBucket	DELETE /mongodb/buckets/	Delete Bucket
BucketApi	getBucket	GET /mongodb/buckets/	Bucket Information
BucketApi	listBuckets	GET /mongodb/buckets	List of Buckets
CollectionApi	aggregate	POST /mongodb/collections/{collectionName}/aggregate	Aggregate in Collection
CollectionApi	clearCollection	DELETE /mongodb/collections/{collectionName}/clear	Clear Collection
CollectionApi	deleteCollection	DELETE /mongodb/collections/	Delete Collection
CollectionApi	distinct	POST /mongodb/collections/{collectionName}/distinct/	Distinct in Collection
CollectionApi	getCollectionFields	GET /mongodb/collections/{collectionName}/fields	Collection Fields
CollectionApi	getCollectionInformation	GET /mongodb/collections/	Collection Information
CollectionApi	getJsonSchema	GET /mongodb/collections/{collectionName}/schema	Collection Fields
CollectionApi	getSchemaAnalysis	GET /mongodb/collections/{collectionName}/schema/analysis	Collection Fields
CollectionApi	listCollections	GET /mongodb/collections	List of Collections
CollectionApi	listCollectionsByDatabase	GET /mongodb/databases/{databaseName}/collections	List of Collections
DatabaseApi	databaseInfos	GET /mongodb/databases/infos	List of Database Infos
DatabaseApi	deleteDatabase	DELETE /mongodb/databases/	Delete Database
DatabaseApi	getDatabaseInfo	GET /mongodb/databases/	Database Infos of selected Database
DatabaseApi	listCollectionsByDatabase	GET /mongodb/databases/{databaseName}/collections	List of Collections
DatabaseApi	listDatabases	GET /mongodb/databases	List of Databases
DocumentApi	delete	DELETE /mongodb/collections/{collectionName}/documents/	Delete Document from Collection
DocumentApi	deleteMany	DELETE /mongodb/collections/{collectionName}/documents/many/delete	Delete Many in Collection
DocumentApi	find	POST /mongodb/collections/{collectionName}/documents	Documents in Collection
DocumentApi	getDocument	GET /mongodb/collections/{collectionName}/documents/	Document from Collection
DocumentApi	insert	PUT /mongodb/collections/{collectionName}/documents	Insert Document
DocumentApi	insertMany	PUT /mongodb/collections/{collectionName}/documents/many/insert	Insert many Documents
DocumentApi	listDocuments	GET /mongodb/collections/{collectionName}/documents	Documents in Collection
DocumentApi	update	PATCH /mongodb/collections/{collectionName}/documents/	Update Document in Collection
DocumentApi	updateDocumentPartial	PATCH /mongodb/collections/{collectionName}/documents/{documentId}/partial	Update Document Parts in Collection
DocumentApi	updateMany	PATCH /mongodb/collections/{collectionName}/documents/many/update	Update many in Collection
FileApi	deleteFile	DELETE /mongodb/buckets/{bucketName}/files/	Delete File from Bucket
FileApi	findFiles	POST /mongodb/buckets/{bucketName}/files	Files in Bucket
FileApi	getFile	GET /mongodb/buckets/{bucketName}/files/{fileId}/file	File from Bucket
FileApi	getFileInformation	GET /mongodb/buckets/{bucketName}/files/	FileInformation from Bucket
FileApi	insertFile	PUT /mongodb/buckets/{bucketName}/files	Insert File
FileApi	listFiles	GET /mongodb/buckets/{bucketName}/files	Files in Bucket
FileApi	updateFileInformation	PATCH /mongodb/buckets/{bucketName}/files/	Update FileInformation in Bucket
IndexApi	createExpiringIndex	PUT /mongodb/collections/{collectionName}/index/field/{fieldName}/{duration}/expiring	Create expiring Index by Field for Collection
IndexApi	createIndex	PUT /mongodb/collections/{collectionName}/index	Create Index for Collection
IndexApi	createIndexForField	PUT /mongodb/collections/{collectionName}/index/field/	Create Index by Field for Collection
IndexApi	createTextIndex	PUT /mongodb/collections/{collectionName}/index/field/{fieldName}/text	Create text index by field for collection
IndexApi	createUniqueIndex	PUT /mongodb/collections/{collectionName}/index/field/{fieldName}/unique	Create Unique Index
IndexApi	deleteIndex	DELETE /mongodb/collections/{collectionName}/index/	Delete Index
IndexApi	index	GET /mongodb/collections/{collectionName}/index/	Index for Collection
IndexApi	listIndices	GET /mongodb/collections/{collectionName}/index	List Indices for Collection
InformationApi	version	GET /version	Version Information
JobsApi	deleteJob	DELETE /system/jobs/{jobGroup}/	Delete Job
JobsApi	executeJob	POST /system/jobs/{jobGroup}/	Execute Job
JobsApi	jobsList	GET /system/jobs	Registered Jobs
JobsApi	possibleJobsList	GET /system/jobs/classes	Possible Jobs
JobsApi	registerJob	PUT /system/jobs	Register Job
JobsApi	updateJob	PATCH /system/jobs/{jobGroup}/	Update Job

Documentation for Models

• BucketInformation
• CollectionStatus
• DatabaseInfo
• DeleteResponse
• ErrorDescription
• FileInformation
• Grant
• IndexCreateRequest
• IndexCreateResponse
• IndexDropResponse
• IndexOptionsRequest
• InsertResponse
• JobConfig
• JobInformation
• JsonSchema
• JsonSchemaDefinition
• JsonValue_Any
• JsonValue_Boolean
• JsonValue_String
• Login
• LoginResult
• Measurement
• Metric
• MongoAggregateRequest
• MongoCampConfiguration
• MongoFindRequest
• MongoIndex
• PasswordUpdateRequest
• PipelineStage
• Role
• SchemaAnalysis
• SchemaAnalysisField
• SchemaAnalysisFieldType
• SettingsResponse
• UpdateFileInformationRequest
• UpdateRequest
• UpdateResponse
• UpdateRoleRequest
• UserInformation
• UserProfile
• Version

Documentation for Authorization

apiKeyAuth

• Type: API key
• API key parameter name: X-AUTH-APIKEY
• Location: HTTP header

httpAuth

• Type: HTTP basic authentication

httpAuth1

• Type: HTTP basic authentication