Package io.apicurio.registry.rest.v3

Interface AdminResource

@Path("/apis/registry/v3/admin") public interface AdminResource
A JAX-RS interface. An implementation of this interface must be provided.

  • Method Details

    • listGlobalRules

      @Path("/rules") @GET @Produces("application/json") List<RuleType> listGlobalRules()

      Gets a list of all the currently configured global rules (if any).

      This operation can fail for the following reasons:

      • A server error occurred (HTTP error 500)

    • createGlobalRule

      @Path("/rules") @POST @Consumes("application/json") void createGlobalRule(@NotNull @NotNull CreateRule data)

      Adds a rule to the list of globally configured rules.

      This operation can fail for the following reasons:

      • The rule type is unknown (HTTP error 400)
      • The rule already exists (HTTP error 409)
      • A server error occurred (HTTP error 500)

    • deleteAllGlobalRules

      @Path("/rules") @DELETE void deleteAllGlobalRules()

      Deletes all globally configured rules.

      This operation can fail for the following reasons:

      • A server error occurred (HTTP error 500)

    • getGlobalRuleConfig

      @Path("/rules/{ruleType}") @GET @Produces("application/json") Rule getGlobalRuleConfig(@PathParam("ruleType") RuleType ruleType)

      Returns information about the named globally configured rule.

      This operation can fail for the following reasons:

      • Invalid rule name/type (HTTP error 400)
      • No rule with name/type rule exists (HTTP error 404)
      • A server error occurred (HTTP error 500)

    • updateGlobalRuleConfig

      @Path("/rules/{ruleType}") @PUT @Produces("application/json") @Consumes("application/json") Rule updateGlobalRuleConfig(@PathParam("ruleType") RuleType ruleType, @NotNull @NotNull Rule data)

      Updates the configuration for a globally configured rule.

      This operation can fail for the following reasons:

      • Invalid rule name/type (HTTP error 400)
      • No rule with name/type rule exists (HTTP error 404)
      • A server error occurred (HTTP error 500)

    • deleteGlobalRule

      @Path("/rules/{ruleType}") @DELETE void deleteGlobalRule(@PathParam("ruleType") RuleType ruleType)

      Deletes a single global rule. If this is the only rule configured, this is the same as deleting all rules.

      This operation can fail for the following reasons:

      • Invalid rule name/type (HTTP error 400)
      • No rule with name/type rule exists (HTTP error 404)
      • Rule cannot be deleted (HTTP error 409)
      • A server error occurred (HTTP error 500)

    • exportData

      @Path("/export") @GET @Produces({"application/json","application/zip"}) jakarta.ws.rs.core.Response exportData(@QueryParam("forBrowser") Boolean forBrowser)

      Exports registry data as a ZIP archive.

    • importData

      @Path("/import") @POST @Consumes("application/zip") void importData(@HeaderParam("X-Registry-Preserve-GlobalId") Boolean xRegistryPreserveGlobalId, @HeaderParam("X-Registry-Preserve-ContentId") Boolean xRegistryPreserveContentId, @QueryParam("requireEmptyRegistry") Boolean requireEmptyRegistry, @NotNull @NotNull InputStream data)

      Imports registry data that was previously exported using the /admin/export operation.

    • getRoleMapping

      @Path("/roleMappings/{principalId}") @GET @Produces("application/json") RoleMapping getRoleMapping(@PathParam("principalId") String principalId)

      Gets the details of a single role mapping (by principalId).

      This operation can fail for the following reasons:

      • No role mapping for the principalId exists (HTTP error 404)
      • A server error occurred (HTTP error 500)

    • updateRoleMapping

      @Path("/roleMappings/{principalId}") @PUT @Consumes("application/json") void updateRoleMapping(@PathParam("principalId") String principalId, @NotNull @NotNull UpdateRole data)

      Updates a single role mapping for one user/principal.

      This operation can fail for the following reasons:

      • No role mapping for the principalId exists (HTTP error 404)
      • A server error occurred (HTTP error 500)

    • deleteRoleMapping

      @Path("/roleMappings/{principalId}") @DELETE void deleteRoleMapping(@PathParam("principalId") String principalId)

      Deletes a single role mapping, effectively denying access to a user/principal.

      This operation can fail for the following reasons:

      • No role mapping for the principalId exists (HTTP error 404)
      • A server error occurred (HTTP error 500)

    • listConfigProperties

      @Path("/config/properties") @GET @Produces("application/json") List<ConfigurationProperty> listConfigProperties()

      Returns a list of all configuration properties that have been set. The list is not paged.

      This operation may fail for one of the following reasons:

      • A server error occurred (HTTP error 500)

    • getConfigProperty

      @Path("/config/properties/{propertyName}") @GET @Produces("application/json") ConfigurationProperty getConfigProperty(@PathParam("propertyName") String propertyName)

      Returns the value of a single configuration property.

      This operation may fail for one of the following reasons:

      • Property not found or not configured (HTTP error 404)
      • A server error occurred (HTTP error 500)

    • updateConfigProperty

      @Path("/config/properties/{propertyName}") @PUT @Consumes("application/json") void updateConfigProperty(@PathParam("propertyName") String propertyName, @NotNull @NotNull UpdateConfigurationProperty data)

      Updates the value of a single configuration property.

      This operation may fail for one of the following reasons:

      • Property not found or not configured (HTTP error 404)
      • A server error occurred (HTTP error 500)

    • resetConfigProperty

      @Path("/config/properties/{propertyName}") @DELETE void resetConfigProperty(@PathParam("propertyName") String propertyName)

      Resets the value of a single configuration property. This will return the property to its default value (see external documentation for supported properties and their default values).

      This operation may fail for one of the following reasons:

      • Property not found or not configured (HTTP error 404)
      • A server error occurred (HTTP error 500)

    • listRoleMappings

      @Path("/roleMappings") @GET @Produces("application/json") RoleMappingSearchResults listRoleMappings(@QueryParam("limit") BigInteger limit, @QueryParam("offset") BigInteger offset)

      Gets a list of all role mappings configured in the registry (if any).

      This operation can fail for the following reasons:

      • A server error occurred (HTTP error 500)

    • createRoleMapping

      @Path("/roleMappings") @POST @Consumes("application/json") void createRoleMapping(@NotNull @NotNull RoleMapping data)

      Creates a new mapping between a user/principal and a role.

      This operation can fail for the following reasons:

      • A server error occurred (HTTP error 500)

    • listArtifactTypes

      @Path("/config/artifactTypes") @GET @Produces("application/json") List<ArtifactTypeInfo> listArtifactTypes()

      Gets a list of all the configured artifact types.

      This operation can fail for the following reasons:

      • A server error occurred (HTTP error 500)

    • triggerSnapshot

      @Path("/snapshots") @POST @Produces("application/json") SnapshotMetaData triggerSnapshot()

      Triggers the creation of a snapshot of the internal database for compatible storages.

      This operation can fail for the following reasons:

      • A server error occurred (HTTP error 500)